fr.sylvainjanet.app.entities

Class LocalizedString

java.lang.Object

fr.sylvainjanet.app.entities.LocalizedString

@Entity(name="messages_localized_string")
public class LocalizedString
extends Object

Localized string.

Author:

Sylvain

Constructor Summary

Constructors

Constructor and Description
LocalizedString() Default constructor.
LocalizedString(List<String> selectors, Map<TextLanguage,String> textMap) Constructor without the id.
LocalizedString(Long id, List<String> selectors, Map<TextLanguage,String> textMap) Full constructor.

Method Summary

Modifier and Type	Method and Description
void	addSelector(String selector) Add a selector to this localized string.
boolean	equals(Object obj) Equals based on id.
String	from(TextLanguage language) Get the text content for a specific language.
Long	getId() Get id.
List<String>	getSelectors() Get selectors.
Map<TextLanguage,String>	getTextMap() Get textMap.
int	hashCode() Hashcode based on id.
boolean	isDefinedFor(TextLanguage language) Is this localized string defined for a language ? The textMap should have a value for this language.
boolean	isDefinedForAllLanguages() Is this localized string defined for all languages ? The textMap should have values for every TextLanguage.
boolean	isForSelector(String selector) Is this localized string used for a selector ? The list of selectors should contain the selector.
boolean	isNonEmptyFor(TextLanguage language) Is this localized string defined and a non null non empty string for a language ? The textMap should have a value for this language.
boolean	isNonEmptyForAllLanguages() Is this localized string defined and a non null non empty string for all languages ? The textMap should have values for every TextLanguage.
boolean	removeSelector(String selector) Remove a selector from this localized string.
void	setId(Long id) Set id.
void	setSelectors(List<String> selectors) Set selectors.
void	setTextMap(Map<TextLanguage,String> textMap) Set textMap.
String	toString() To String method.
String	translateIn(TextLanguage language, String text) Translates this string in a specific language.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalizedString

public LocalizedString()

Default constructor.

LocalizedString

public LocalizedString(Long id,
                       List<String> selectors,
                       Map<TextLanguage,String> textMap)

Full constructor.

Parameters:

id - the id

selectors - the selectors

textMap - the textMap

LocalizedString

public LocalizedString(List<String> selectors,
                       Map<TextLanguage,String> textMap)

Constructor without the id.

Parameters:

selectors - the selectors

textMap - the textMap

Method Detail

isDefinedForAllLanguages

public boolean isDefinedForAllLanguages()

Is this localized string defined for all languages ? The textMap should have values for every TextLanguage.

Returns:

Whether or not this localized string defined for all languages.

isDefinedFor

public boolean isDefinedFor(TextLanguage language)

Is this localized string defined for a language ? The textMap should have a value for this language.

Parameters:

language - the language to look at

Returns:

Whether or not this localized string defined for a language

isNonEmptyForAllLanguages

public boolean isNonEmptyForAllLanguages()

Is this localized string defined and a non null non empty string for all languages ? The textMap should have values for every TextLanguage.

Returns:

Whether or not this localized string defined and a non null non empty string for all languages.

isNonEmptyFor

public boolean isNonEmptyFor(TextLanguage language)

Is this localized string defined and a non null non empty string for a language ? The textMap should have a value for this language.

Parameters:

language - the language to look at

Returns:

Whether or not this localized string defined and a non null non empty string for a language

isForSelector

public boolean isForSelector(String selector)

Is this localized string used for a selector ? The list of selectors should contain the selector.

Parameters:

selector - the selector to test

Returns:

whether or not his localized string used for the selector.

addSelector

public void addSelector(String selector)

Add a selector to this localized string.

Parameters:

selector - the selector

removeSelector

public boolean removeSelector(String selector)

Remove a selector from this localized string.

Parameters:

selector - the selector

Returns:

true if the selector list contained the given element

from

public String from(TextLanguage language)

Get the text content for a specific language.

Parameters:

language - the language

Returns:

the text content in that specific language

translateIn

public String translateIn(TextLanguage language,
                          String text)

Translates this string in a specific language.

Parameters:

language - the language

text - the text content in that specific language

Returns:

the previous value associated with key, or null if there was no mapping for key

getId

public Long getId()

Get id.

Returns:

the id

setId

public void setId(Long id)

Set id.

Parameters:

id - the id to set

getSelectors

public List<String> getSelectors()

Get selectors.

Returns:

the selectors

setSelectors

public void setSelectors(List<String> selectors)

Set selectors.

Parameters:

selectors - the selectors to set

getTextMap

public Map<TextLanguage,String> getTextMap()

Get textMap.

Returns:

the textMap

setTextMap

public void setTextMap(Map<TextLanguage,String> textMap)

Set textMap.

Parameters:

textMap - the textMap to set

hashCode

public int hashCode()

Hashcode based on id.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Equals based on id.

Overrides:

equals in class Object

toString

public String toString()

To String method.

Overrides:

toString in class Object