de.espirit.firstspirit.access

Interface Language

All Superinterfaces:

Comparable<Language>

public interface Language
extends Comparable<Language>

A Language

Since:

3.0

Method Summary

Methods

Modifier and Type	Method and Description
String	getAbbreviation() Get the abbreviation used for this language, for example "DE" for "German".
String	getDisplayName(Language language) Gets display name of the Language for the given language.
String	getHTMLEncoding() Gets the HTMLEncoding of this language
Locale	getLocale() Return Locale corresponding to this language
String	getName() Get the name of this language
boolean	isMasterLanguage() Returns true if this language is the master language of the belonging project, false otherwise
void	setDisplayName(Language language, String displayName) Sets the display name of the Language for the given language
void	setGenerate(boolean shouldGenerate) Activates/deactivates the generation of this language.
void	setHTMLEncoding(String encoding) Set the HTMLEncoding
void	setLocale(Locale locale) Sets the locale for this language
void	setMasterLanguage(boolean status) Sets this language as master language
void	setName(String name) Sets the name
boolean	shouldGenerate() Should this language be generated?

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getAbbreviation

String getAbbreviation()

Get the abbreviation used for this language, for example "DE" for "German". This abbreviation should be a valid ISO 3166 country code but no test for correctness is performed at creation time of the object.

Returns:

the abbreviation

Since:

3.0

getName

String getName()

Get the name of this language

Returns:

the name

Since:

3.0

setName

void setName(String name)

Sets the name

Parameters:

name - the new name

Since:

3.0

getDisplayName

@Nullable
String getDisplayName(Language language)

Gets display name of the Language for the given language.

Parameters:

language -

Returns:

the name or null if not defined

Since:

4.2.15

setDisplayName

void setDisplayName(Language language,
                  String displayName)

Sets the display name of the Language for the given language

Parameters:

displayName - the new displayname

language - the language to set the display name for

Since:

4.2.15

getHTMLEncoding

String getHTMLEncoding()

Gets the HTMLEncoding of this language

Returns:

the HTMLEncoding

Since:

3.0

setHTMLEncoding

void setHTMLEncoding(String encoding)

Set the HTMLEncoding

Parameters:

encoding - the new HTMLEncoding value

Since:

3.0

shouldGenerate

boolean shouldGenerate()

Should this language be generated?

Returns:

the shouldGenerate value

Since:

4.0

setGenerate

void setGenerate(boolean shouldGenerate)

Activates/deactivates the generation of this language.

Since:

4.0

getLocale

Locale getLocale()

Return Locale corresponding to this language

Since:

4.0

setLocale

void setLocale(Locale locale)

Sets the locale for this language

Parameters:

locale -

Since:

4.0

isMasterLanguage

boolean isMasterLanguage()

Returns true if this language is the master language of the belonging project, false otherwise

Returns:

returns true if this language is master language, false otherwise

Since:

4.0

setMasterLanguage

void setMasterLanguage(boolean status)

Sets this language as master language

Since:

4.0