com.alee.managers.language.data

Class Record

java.lang.Object

com.alee.managers.language.data.Record

All Implemented Interfaces:

Serializable, Cloneable

public final class Record
extends Object
implements Cloneable, Serializable

Record can store multiple Values for different Locales. It can also provide single and multiple Values for any specific Locale if such exist.

Author:

Mikle Garin

See Also:

How to use LanguageManager, LanguageManager, Language, Dictionary, Value, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Record() Constructs new Record.
Record(String key) Constructs new Record.
Record(String key, List<Value> values) Constructs new Record.
Record(String key, Value... values) Constructs new Record.

Method Summary

Modifier and Type	Method and Description
void	addValue(Value value) Adds new Value for this Record.
void	clearValues() Removes all Values from this Record.
protected void	collectAllCodes(List<String> codes) Collects all language codes from this Record.
protected void	collectAllLocales(List<Locale> locales) Collects all Locales from this Record.
String	getKey() Returns Record key within its Dictionary.
Value	getValue(Locale locale) Returns Value most fitting for the specified Locale.
List<Value>	getValues() Returns Values of this Record.
List<Value>	getValues(Locale locale) Returns List of Values for the specified Locale.
boolean	hasValue(Locale locale) Returns whether or not this Record has Value for the specified Locale.
void	removeValue(Value value) Removes Value from this Record.
void	setKey(String key) Sets Record key within its Dictionary.
void	setValues(List<Value> values) Sets Values for this Record.
String	toString()
String	toString(boolean boldKey) Returns Record text representation.
int	valuesCount() Returns amount of Values within this Record.

Methods inherited from class java.lang.Object

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

Constructor Detail

Record

public Record()

Constructs new Record.

Record

public Record(@NotNull
              String key)

Constructs new Record.

Parameters:

key - Record key within its Dictionary

Record

public Record(@NotNull
              String key,
              @NotNull
              Value... values)

Constructs new Record.

Parameters:

key - Record key within its Dictionary

values - Values for new Record

Record

public Record(@NotNull
              String key,
              @NotNull
              List<Value> values)

Constructs new Record.

Parameters:

key - Record key within its Dictionary

values - Values for new Record

Method Detail

getKey

@NotNull
public String getKey()

Returns Record key within its Dictionary.

Returns:

Record key within its Dictionary

setKey

public void setKey(@NotNull
                   String key)

Sets Record key within its Dictionary.

Parameters:

key - new Record key within its Dictionary

getValues

@NotNull
public List<Value> getValues()

Returns Values of this Record.

Returns:

Values of this Record

setValues

public void setValues(@NotNull
                      List<Value> values)

Sets Values for this Record.

Parameters:

values - new Values for this Record

addValue

public void addValue(@NotNull
                     Value value)

Adds new Value for this Record.

Parameters:

value - new Value

removeValue

public void removeValue(@NotNull
                        Value value)

Removes Value from this Record.

Parameters:

value - Value to remove

clearValues

public void clearValues()

Removes all Values from this Record.

valuesCount

public int valuesCount()

Returns amount of Values within this Record.

Returns:

amount of Values within this Record

collectAllLocales

protected void collectAllLocales(@NotNull
                                 List<Locale> locales)

Collects all Locales from this Record.

Parameters:

locales - List to put Locales into

collectAllCodes

protected void collectAllCodes(@NotNull
                               List<String> codes)

Collects all language codes from this Record.

Parameters:

codes - List to put language codes into

hasValue

public boolean hasValue(@NotNull
                        Locale locale)

Returns whether or not this Record has Value for the specified Locale.

Parameters:

locale - Locale to check Value for

Returns:

true if this Record has Value for the specified Locale, false otherwise

getValue

@Nullable
public Value getValue(@NotNull
                                Locale locale)

Returns Value most fitting for the specified Locale.

Parameters:

locale - Locale to provide Value for

Returns:

Value most fitting for the specified Locale

getValues

@NotNull
public List<Value> getValues(@NotNull
                                      Locale locale)

Returns List of Values for the specified Locale.

Parameters:

locale - Locale to provide Values for

Returns:

List of Value for the specified Locale

toString

@NotNull
public String toString()

Overrides:

toString in class Object

toString

@NotNull
public String toString(boolean boldKey)

Returns Record text representation.

Parameters:

boldKey - whether or not key should be displayed bold

Returns:

Record text representation