com.hp.util.format

Class SimpleTokenMessageTranslator

java.lang.Object

com.hp.util.format.SimpleTokenMessageTranslator

All Implemented Interfaces:

TokenMessageTranslator

Direct Known Subclasses:

RestrictedTokenMessageTranslator

public class SimpleTokenMessageTranslator
extends Object
implements TokenMessageTranslator

Formats message strings by translating tokens by their replacement values within the given message string. Token variables can be identified by the following formats:

         %foo
         %{foo}
 

The % character and the {} enclosing characters can be tailored during construction or by calling one of the appropriate set methods.

Author:

Thomas Vachuska

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALPHANUMERIC String constant of all legal alpha-numeric characters.
static String	ALPHANUMERIC_PUNCTUATION String consisting of all alphanumeric characters, ',', '.', '-', and '_'
static char	DEFAULT_TOKEN_CHAR Default token flag value.
static char	DEFAULT_TOKEN_END Default (optional) token end delimiter.
static char	DEFAULT_TOKEN_START Default (optional) token start delimiter.
protected String	validCharacters

Constructor Summary

Constructors

Constructor and Description
SimpleTokenMessageTranslator() Constructs a new translator setup to recognise tokens using the default characters for the flag and start/end character pairs.
SimpleTokenMessageTranslator(char tokenChar) Constructs a new translator setup to recognise tokens using the specified characters for the flag and default start/end character pairs.
SimpleTokenMessageTranslator(char tokenChar, char tokenStartChar, char tokenEndChar) Constructs a new translator setup to recognise tokens using the specified characters for the flag and start/end character pairs.

Method Summary

Methods

Modifier and Type	Method and Description
char	getTokenChar() Returns the token flag used by this translator.
char	getTokenEndChar() Returns the optional token end delimiter used by this translator.
char	getTokenStartChar() Returns the optional token start delimiter used by this translator.
void	setTokenChar(char c) Sets the token flag used by this translator.
void	setTokenEndChar(char c) Sets the optional token end delimiter used by this translator.
void	setTokenStartChar(char c) Sets the optional token start delimiter used by this translator.
String	translate(String message, TokenTranslator translator) Replace all token strings within the specified message using the substitution services of the given translator.

Methods inherited from class java.lang.Object

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

Field Detail

ALPHANUMERIC

public static final String ALPHANUMERIC

String constant of all legal alpha-numeric characters.

See Also:

Constant Field Values

ALPHANUMERIC_PUNCTUATION

public static final String ALPHANUMERIC_PUNCTUATION

String consisting of all alphanumeric characters, ',', '.', '-', and '_'

See Also:

Constant Field Values

validCharacters

protected String validCharacters

DEFAULT_TOKEN_CHAR

public static final char DEFAULT_TOKEN_CHAR

Default token flag value.

See Also:

Constant Field Values

DEFAULT_TOKEN_START

public static final char DEFAULT_TOKEN_START

Default (optional) token start delimiter.

See Also:

Constant Field Values

DEFAULT_TOKEN_END

public static final char DEFAULT_TOKEN_END

Default (optional) token end delimiter.

See Also:

Constant Field Values

Constructor Detail

SimpleTokenMessageTranslator

public SimpleTokenMessageTranslator()

Constructs a new translator setup to recognise tokens using the default characters for the flag and start/end character pairs.

SimpleTokenMessageTranslator

public SimpleTokenMessageTranslator(char tokenChar)

Constructs a new translator setup to recognise tokens using the specified characters for the flag and default start/end character pairs.

Parameters:

tokenChar - token identification character

SimpleTokenMessageTranslator

public SimpleTokenMessageTranslator(char tokenChar,
                            char tokenStartChar,
                            char tokenEndChar)

Constructs a new translator setup to recognise tokens using the specified characters for the flag and start/end character pairs.

Parameters:

tokenChar - token identification character

tokenStartChar - start of token character

tokenEndChar - end of token character

Method Detail

getTokenChar

public char getTokenChar()

Returns the token flag used by this translator.

Returns:

token identification character

setTokenChar

public void setTokenChar(char c)

Sets the token flag used by this translator.

Parameters:

c - token identification character

getTokenStartChar

public char getTokenStartChar()

Returns the optional token start delimiter used by this translator.

Returns:

token start character

setTokenStartChar

public void setTokenStartChar(char c)

Sets the optional token start delimiter used by this translator.

Parameters:

c - new token start character

getTokenEndChar

public char getTokenEndChar()

Returns the optional token end delimiter used by this translator.

Returns:

token end character

setTokenEndChar

public void setTokenEndChar(char c)

Sets the optional token end delimiter used by this translator.

Parameters:

c - new token end character

translate

public String translate(String message,
               TokenTranslator translator)

Replace all token strings within the specified message using the substitution services of the given translator.

Specified by:

translate in interface TokenMessageTranslator

Parameters:

message - message string whose tokens are to be translated

translator - token translator

Returns:

translated message string