net.pandoragames.util.i18n

Class LocalizableText

java.lang.Object

net.pandoragames.util.i18n.LocalizableText

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class LocalizableText
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

This object represents a little piece of textual information that can be transformed from some application internal code into a human readable text of a specific language, say it can be localized. While the transformation from code into text is generally a static one-to-one replacement, the resulting text may be filled with variable information, using the means provided by the java.text.MessageFormat class.
The class should be considdered immutable in so far, that code and replacement objects can not be changed once the object is created.

Author:

Olivier Wehner

See Also:

MessageFormat, Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocalizableText(java.lang.String code) Creates a new instance withe the specified message code
LocalizableText(java.lang.String code, java.lang.Object replacementValue) Creates a new instance withe the specified message code and one replace ment value.
LocalizableText(java.lang.String code, java.lang.Object[] replacementValues) Creates a new instance withe the specified message code and any number of replacement values.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a 1:1 deep copy of this object.
boolean	equals(java.lang.Object o) Two instances of LocalizableText are considdered equal if they carry the same code, and the same set of replacement objects.
java.lang.String	getCode() Returns the application internal code for this text object
java.lang.String	getLanguage() Returns the two letter language code this textobject was localized with or null, if the textobject wasn't yet localized.
java.lang.String	getText() Returns the localized text.
protected java.lang.Object[]	getVariables() Inheriting classes may have to have access to the replacement values of this object, but they should never be altered and are therefor sealed with a protected accessor.
int	hashCode() Overridden to be consistent with equals;
void	localize(Localizer loco) Trys to translate the code into some human readable text using the specified Localizer.
java.lang.String	toString() Returns the short name of this class followed by code and language

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalizableText

public LocalizableText(java.lang.String code)

Creates a new instance withe the specified message code

Parameters:

code - application internal code for some message text

LocalizableText

public LocalizableText(java.lang.String code,
               java.lang.Object replacementValue)

Creates a new instance withe the specified message code and one replace ment value.

Parameters:

code - application internal code for some message text

replacementValue - used with java.text.MessageFormat

LocalizableText

public LocalizableText(java.lang.String code,
               java.lang.Object[] replacementValues)

Creates a new instance withe the specified message code and any number of replacement values.

Parameters:

code - application internal code for some message text

replacementValues - used with java.text.MessageFormat

Method Detail

getCode

public java.lang.String getCode()

Returns the application internal code for this text object

getText

public java.lang.String getText()

Returns the localized text. If localization failed or took not yet place, the original code is returned.

Returns:

text for display to human user

localize

public void localize(Localizer loco)

Trys to translate the code into some human readable text using the specified Localizer. If this object has allready been localized with the language or the specified localizer, the call to this method is ignored.

getLanguage

public java.lang.String getLanguage()

Returns the two letter language code this textobject was localized with or null, if the textobject wasn't yet localized.

toString

public java.lang.String toString()

Returns the short name of this class followed by code and language

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Returns a 1:1 deep copy of this object.

Overrides:

clone in class java.lang.Object

See Also:

Object.clone()

getVariables

protected java.lang.Object[] getVariables()

Inheriting classes may have to have access to the replacement values of this object, but they should never be altered and are therefor sealed with a protected accessor.

Returns:

Returns the replacement variables that should be inserted in the localized text using java.text.MessageFormat

equals

public boolean equals(java.lang.Object o)

Two instances of LocalizableText are considdered equal if they carry the same code, and the same set of replacement objects.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overridden to be consistent with equals;

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()