com.alee.managers.language.data

Class Text

java.lang.Object

com.alee.managers.language.data.Text

All Implemented Interfaces:

Serializable, Cloneable

@XStreamConverter(value=TextConverter.class)
public final class Text
extends Object
implements Cloneable, Serializable

Text represents translation for a single translation key, language and state.

Author:

Mikle Garin

See Also:

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

Constructor Summary

Constructors

Constructor and Description
Text() Constructs new Text with default state and empty text.
Text(String text) Constructs new Text with default state and specified translation text.
Text(String text, String state) Constructs new Text with the specified state and translation text.
Text(String text, String state, int mnemonic) Constructs new Text with the specified state and translation text.

Method Summary

Modifier and Type	Method and Description
int	getMnemonic() Returns mnemonic character.
String	getState() Returns state this translation is used for.
String	getText(Object... data) Returns parsed text or raw contents depending on provided data.
void	setMnemonic(int mnemonic) Sets mnemonic character.
void	setState(String state) Sets state this translation is used for.
void	setText(String text) Sets translation text.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Text

public Text()

Constructs new Text with default state and empty text.

Text

public Text(@NotNull
            String text)

Constructs new Text with default state and specified translation text.

Parameters:

text - translation text

Text

public Text(@NotNull
            String text,
            @Nullable
            String state)

Constructs new Text with the specified state and translation text.

Parameters:

text - translation text

state - state this translation is used for

Text

public Text(@NotNull
            String text,
            @Nullable
            String state,
            int mnemonic)

Constructs new Text with the specified state and translation text.

Parameters:

text - translation text

state - state this translation is used for

mnemonic - mnemonic character

Method Detail

getText

@NotNull
public String getText(@NotNull
                               Object... data)

Returns parsed text or raw contents depending on provided data.

Parameters:

data - language data to process

Returns:

parsed text or raw contents depending on provided data

setText

public void setText(@NotNull
                    String text)

Sets translation text.

Parameters:

text - translation text

getState

@Nullable
public String getState()

Returns state this translation is used for.

Returns:

state this translation is used for

setState

public void setState(@Nullable
                     String state)

Sets state this translation is used for.

Parameters:

state - state this translation is used for

getMnemonic

public int getMnemonic()

Returns mnemonic character.

Returns:

mnemonic character

setMnemonic

public void setMnemonic(int mnemonic)

Sets mnemonic character.

Parameters:

mnemonic - new mnemonic character

toString

@NotNull
public String toString()

Overrides:

toString in class Object