com.hp.util.format

Class InvalidTokenTranslator

java.lang.Object

com.hp.util.format.InvalidTokenTranslator

All Implemented Interfaces:

TokenTranslator

Direct Known Subclasses:

MapTranslator, ReflectionTranslator, ResourceBundleTokenTranslator

public abstract class InvalidTokenTranslator
extends Object
implements TokenTranslator

Abstraction of a translator whose treatment of illegal or invalid tokens is customizable.

Author:

Thomas Vachuska

Field Summary

Fields

Modifier and Type	Field and Description
protected int	behaviour Flag specifying how the translator will deal with illegal tokens.
protected String	empty Representation of the empty string; truly empty by default.
static int	RETURN_EMPTY_STRING Specifies translation behaviour where invalid tokens will be translated to an empty string.
static int	RETURN_NULL Specifies translation behaviour where invalid tokens will be translated to a null value.
static int	RETURN_TOKEN_STRING Specifies translation behaviour where invalid tokens will be translated to the token string itself, i.e.

Constructor Summary

Constructors

Constructor and Description
InvalidTokenTranslator() Constructs a translator that will translate illegal tokens to null values.
InvalidTokenTranslator(int behaviour) Constructs a translator that will treat illegal tokens according to the given behaviour.

Method Summary

Methods

Modifier and Type	Method and Description
int	getBehaviour() Returns true if the translator will allow illegal tokens.
String	getEmptyString() Sets the value of the empty string to be used in lieu of the invalid token.
void	setBehaviour(int behaviour) Sets the behaviour for treatment of illegal tokens.
void	setEmptyString(String empty) Sets the value of the empty string to be used in lieu of the invalid token.
String	translateInvalidToken(String token) Translates the illegal token into its value depending on the currently configured mode of behaviour.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hp.util.format.TokenTranslator

translate

Field Detail

RETURN_NULL

public static final int RETURN_NULL

Specifies translation behaviour where invalid tokens will be translated to a null value.

See Also:

Constant Field Values

RETURN_EMPTY_STRING

public static final int RETURN_EMPTY_STRING

Specifies translation behaviour where invalid tokens will be translated to an empty string.

See Also:

Constant Field Values

RETURN_TOKEN_STRING

public static final int RETURN_TOKEN_STRING

Specifies translation behaviour where invalid tokens will be translated to the token string itself, i.e. will not be translated.

See Also:

Constant Field Values

behaviour

protected int behaviour

Flag specifying how the translator will deal with illegal tokens.

empty

protected String empty

Representation of the empty string; truly empty by default.

Constructor Detail

InvalidTokenTranslator

public InvalidTokenTranslator()

Constructs a translator that will translate illegal tokens to null values.

InvalidTokenTranslator

public InvalidTokenTranslator(int behaviour)

Constructs a translator that will treat illegal tokens according to the given behaviour.

Parameters:

behaviour - behaviour of dealing with illegal tokens

Method Detail

getBehaviour

public int getBehaviour()

Returns true if the translator will allow illegal tokens.

Returns:

current behaviour of dealing with illegal tokens

setBehaviour

public void setBehaviour(int behaviour)

Sets the behaviour for treatment of illegal tokens.

Parameters:

behaviour - behaviour of dealing with illegal tokens

getEmptyString

public String getEmptyString()

Sets the value of the empty string to be used in lieu of the invalid token.

Returns:

'empty' string value

setEmptyString

public void setEmptyString(String empty)

Sets the value of the empty string to be used in lieu of the invalid token.

Parameters:

empty - new 'empty' string value

translateInvalidToken

public String translateInvalidToken(String token)

Translates the illegal token into its value depending on the currently configured mode of behaviour.

Parameters:

token - invalid token

Returns:

value of the invalid token