com.hp.util.format

Class ResourceBundleTokenTranslator

java.lang.Object

com.hp.util.format.InvalidTokenTranslator

com.hp.util.format.ResourceBundleTokenTranslator

All Implemented Interfaces:

TokenTranslator

public class ResourceBundleTokenTranslator
extends InvalidTokenTranslator

This is an implementation of the TokenTranslator interface that reads tokens from a specified ResourceBundle. It can optionally use the MessageFormat class to substitute values at arbitrary positions in the translated String.

Author:

Scott Pontillo

Field Summary

Fields

Modifier and Type	Field and Description
static char	DEFAULT_KEY_SEPARATOR
static char	DEFAULT_VALUE_SEPARATOR

Fields inherited from class com.hp.util.format.InvalidTokenTranslator

behaviour, empty, RETURN_EMPTY_STRING, RETURN_NULL, RETURN_TOKEN_STRING

Constructor Summary

Constructors

Constructor and Description
ResourceBundleTokenTranslator(ResourceBundle rb)
ResourceBundleTokenTranslator(ResourceBundle rb, boolean useMessageFormat)
ResourceBundleTokenTranslator(ResourceBundle rb, boolean useMessageFormat, int behaviour)
ResourceBundleTokenTranslator(ResourceBundle rb, int behaviour)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getUseMessageFormat() Returns true if this ResourceBundleTokenTranslator is using MesasgeFormat functionality; false otherwise.
void	setKeySeparator(String s) Sets the character that is used to separate the key from the values.
void	setUseMessageFormat(boolean tf) This method must be called if the MessageFormat functionality is to be used.
void	setValueSeparator(String s) Sets the character that is used to separate values.
String	translate(String token) Translates the given string based on the format: [:] Where is a comma separated list of value strings.

Methods inherited from class com.hp.util.format.InvalidTokenTranslator

getBehaviour, getEmptyString, setBehaviour, setEmptyString, translateInvalidToken

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_KEY_SEPARATOR

public static final char DEFAULT_KEY_SEPARATOR

See Also:

Constant Field Values

DEFAULT_VALUE_SEPARATOR

public static final char DEFAULT_VALUE_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

ResourceBundleTokenTranslator

public ResourceBundleTokenTranslator(ResourceBundle rb)

ResourceBundleTokenTranslator

public ResourceBundleTokenTranslator(ResourceBundle rb,
                             int behaviour)

ResourceBundleTokenTranslator

public ResourceBundleTokenTranslator(ResourceBundle rb,
                             boolean useMessageFormat)

ResourceBundleTokenTranslator

public ResourceBundleTokenTranslator(ResourceBundle rb,
                             boolean useMessageFormat,
                             int behaviour)

Method Detail

setUseMessageFormat

public void setUseMessageFormat(boolean tf)

This method must be called if the MessageFormat functionality is to be used.

Parameters:

tf - true to use message format; false otherwise

getUseMessageFormat

public boolean getUseMessageFormat()

Returns true if this ResourceBundleTokenTranslator is using MesasgeFormat functionality; false otherwise.

Returns:

true if the message format is to be used; false otherwise

setValueSeparator

public void setValueSeparator(String s)

Sets the character that is used to separate values. (Only used when multiple values exist) Defaults to ','.

Parameters:

s - new value separator

setKeySeparator

public void setKeySeparator(String s)

Sets the character that is used to separate the key from the values. Defaults to ':'.

Parameters:

s - new key separator

translate

public String translate(String token)

Translates the given string based on the format: [:] Where is a comma separated list of value strings. Value strings will be passed into the MessageFormat class if setUseMessageFormat(true) has been called. Otherwise, the string will not be parsed.

Parameters:

token - original token string

Returns:

replacement string