com.alee.managers.language

Class Language

java.lang.Object

com.alee.managers.language.Language

All Implemented Interfaces:

Serializable

public class Language
extends Object
implements Serializable

Provides access to translations for one specific language. This class doesn't store anything on its own and only acts as a proxy to LanguageManager.

Author:

Mikle Garin

See Also:

How to use LanguageManager, LanguageManager, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Locale	locale Locale of this Language.

Constructor Summary

Constructors

Constructor and Description
Language(Locale locale) Constructs new Language for the specified Locale.

Method Summary

Modifier and Type	Method and Description
boolean	contains(String key) Returns whether or not specified language key exists in this Language.
boolean	containsText(String key) Returns whether or not at least single Text exists for specified language key.
boolean	containsText(String key, String state) Returns whether or not at least single Text exists for specified language key and state.
boolean	equals(Object language)
String	get(String key, Object... data) Returns text for the specified language key from this Language.
Dictionary	getDictionaries() Returns Dictionary containing all registered Dictionarys.
Locale	getLocale() Returns Locale of this Language.
int	getMnemonic(String key) Returns mnemonic for the specified language key from this Language.
int	getMnemonic(String key, String state) Returns mnemonic for the specified language key from this Language.
Record	getRecord(String key) Returns Record for the specified language key.
String	getState(String key, String state, Object... data) Returns text for the specified language key and state from this Language.
Text	getText(String key) Returns default state Text for the specified language key and Locale from this Language.
Text	getText(String key, String state) Returns Text for the specified language key and Locale from this Language.
Value	getValue(String key) Returns Value for the specified language key and Locale from this Language.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

locale

@NotNull
protected final Locale locale

Locale of this Language.

Constructor Detail

Language

public Language(@NotNull
                Locale locale)

Constructs new Language for the specified Locale.

Parameters:

locale - Locale for new Language

Method Detail

getLocale

@NotNull
public Locale getLocale()

Returns Locale of this Language.

Returns:

Locale of this Language

getDictionaries

@NotNull
public Dictionary getDictionaries()

Returns Dictionary containing all registered Dictionarys.

Returns:

Dictionary containing all registered Dictionarys

getRecord

@Nullable
public Record getRecord(@Nullable
                                  String key)

Returns Record for the specified language key.

Parameters:

key - language key to retrieve Record for

Returns:

Record for the specified language key

getValue

@Nullable
public Value getValue(@Nullable
                                String key)

Returns Value for the specified language key and Locale from this Language.

Parameters:

key - language key to retrieve Value for

Returns:

Value for the specified language key and Locale from this Language

getText

@Nullable
public Text getText(@Nullable
                              String key)

Returns default state Text for the specified language key and Locale from this Language.

Parameters:

key - language key to retrieve Text for

Returns:

default state Text for the specified language key and Locale from this Language

getText

@Nullable
public Text getText(@Nullable
                              String key,
                              @Nullable
                              String state)

Returns Text for the specified language key and Locale from this Language.

Parameters:

key - language key to retrieve Text for

state - Text state

Returns:

Text for the specified language key and Locale from this Language

get

@NotNull
public String get(@Nullable
                           String key,
                           @NotNull
                           Object... data)

Returns text for the specified language key from this Language.

Parameters:

key - language key to retrieve text for

data - language data

Returns:

text for the specified language key from this Language

getState

@NotNull
public String getState(@Nullable
                                String key,
                                @Nullable
                                String state,
                                @NotNull
                                Object... data)

Returns text for the specified language key and state from this Language.

Parameters:

key - language key to retrieve text for

state - Text state

data - language data

Returns:

text for the specified language key and state from this Language

getMnemonic

public int getMnemonic(@Nullable
                       String key)

Returns mnemonic for the specified language key from this Language.

Parameters:

key - language key to retrieve mnemonic for

Returns:

mnemonic for the specified language key from this Language

getMnemonic

public int getMnemonic(@Nullable
                       String key,
                       @Nullable
                       String state)

Returns mnemonic for the specified language key from this Language.

Parameters:

key - language key to retrieve mnemonic for

state - Text state

Returns:

mnemonic for the specified language key from this Language

contains

public boolean contains(@Nullable
                        String key)

Returns whether or not specified language key exists in this Language. This will basically check existence of at least single Record with the key.

Parameters:

key - language key to check

Returns:

true if specified language key exists in this Language, false otherwise

containsText

public boolean containsText(@Nullable
                            String key)

Returns whether or not at least single Text exists for specified language key.

Parameters:

key - language key to check

Returns:

true if at least single Text exists for specified language key, false otherwise

containsText

public boolean containsText(@Nullable
                            String key,
                            @Nullable
                            String state)

Returns whether or not at least single Text exists for specified language key and state.

Parameters:

key - language key to check

state - Text state

Returns:

true if at least single Text exists for specified language key and state, false otherwise

equals

public boolean equals(@Nullable
                      Object language)

Overrides:

equals in class Object

toString

@NotNull
public String toString()

Overrides:

toString in class Object