com.whitestein.lsps.engine

Class LocalizationKey

java.lang.Object

com.whitestein.lsps.engine.LocalizationKey

All Implemented Interfaces:

java.io.Serializable

public class LocalizationKey
extends java.lang.Object
implements java.io.Serializable

Value object that holds informations about a localizable string.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IDENTIFIER_PREFIX Identifier of localizable strings

Constructor Summary

Constructors

Constructor and Description
LocalizationKey(java.lang.String moduleHash, java.lang.String identifier, java.io.Serializable[] parameters) Full constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	asLocalizableString() Returns as localizable string with properly encoded parameters.
java.lang.String	asResourceKey() Returns the key (module::version::identifier::paramCount) used as key in resource bundle.
java.lang.String	getIdentifier() Gets the identifier.
java.lang.String	getModuleHash() Gets the module hash.
java.io.Serializable[]	getParameters() Returns the parameters of the localizable string.
static LocalizationKey	parse(java.lang.String source) Returns a localizable string object if the source is a valid localizable string, otherwise null is returned.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

IDENTIFIER_PREFIX

public static final java.lang.String IDENTIFIER_PREFIX

Identifier of localizable strings

See Also:

Constant Field Values

Constructor Detail

LocalizationKey

public LocalizationKey(java.lang.String moduleHash,
                       java.lang.String identifier,
                       java.io.Serializable[] parameters)

Full constructor.

Parameters:

moduleHash -

identifier -

parameters -

Method Detail

parse

public static LocalizationKey parse(java.lang.String source)

Returns a localizable string object if the source is a valid localizable string, otherwise null is returned.

Parameters:

source - source string

Returns:

LocalizationKey instance or null if source could not be parsed

getModuleHash

public java.lang.String getModuleHash()

Gets the module hash.

Returns:

the module hash

getIdentifier

public java.lang.String getIdentifier()

Gets the identifier.

Returns:

the identifier

getParameters

public java.io.Serializable[] getParameters()

Returns the parameters of the localizable string.

Returns:

parameters

asResourceKey

public java.lang.String asResourceKey()

Returns the key (module::version::identifier::paramCount) used as key in resource bundle.

Returns:

resource key

asLocalizableString

public java.lang.String asLocalizableString()

Returns as localizable string with properly encoded parameters.

Returns:

localizable string

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object