com.hp.util.format

Class MapTranslator

java.lang.Object

com.hp.util.format.InvalidTokenTranslator

com.hp.util.format.MapTranslator

All Implemented Interfaces:

TokenTranslator

public class MapTranslator
extends InvalidTokenTranslator

Formats message strings by substituting results of a map lookup for the specified key string. It can be used in several different ways.

Author:

Thomas Vachuska

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	map Map used to perform token translation.

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
MapTranslator(Map<String,Object> map) Constructs a mapped translator that will use the specified map to translate the tokens into their values.
MapTranslator(Map<String,Object> map, int behaviour) Constructs a mapped translator that will use the specified map to translate the tokens into their values and will treat illegal tokens according to the given behaviour.
MapTranslator(Object[] objects) Constructs a mapped translator that will translate the specified array into a map, where the value is the object and the key is the string image of the index at which the object was located in the array.
MapTranslator(Object[][] bindings) Constructs a mapped translator that will translate the specified two column array as a map, which it will use to translate the tokens into their values.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	getMap() Returns the map whose methods the translator invokes.
void	setMap(Map<String,Object> map) Sets the map whose methods the translator will invoke.
String	translate(String token) Returns a replacement string for the original token string.

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

map

protected Map<String,Object> map

Map used to perform token translation.

Constructor Detail

MapTranslator

public MapTranslator(Map<String,Object> map)

Constructs a mapped translator that will use the specified map to translate the tokens into their values.

Parameters:

map - map of token-to-value bindings

MapTranslator

public MapTranslator(Map<String,Object> map,
             int behaviour)

Constructs a mapped translator that will use the specified map to translate the tokens into their values and will treat illegal tokens according to the given behaviour.

Parameters:

map - map of token-to-value bindings

behaviour - behaviour when dealing with invalid tokens

MapTranslator

public MapTranslator(Object[][] bindings)

Constructs a mapped translator that will translate the specified two column array as a map, which it will use to translate the tokens into their values.

Parameters:

bindings - array of token/value bindings

MapTranslator

public MapTranslator(Object[] objects)

Constructs a mapped translator that will translate the specified array into a map, where the value is the object and the key is the string image of the index at which the object was located in the array. This map will then be used to translate the tokens into their values.

Parameters:

objects - numbered array of values

Method Detail

getMap

public Map<String,Object> getMap()

Returns the map whose methods the translator invokes.

Returns:

current map of token/value bindings

setMap

public void setMap(Map<String,Object> map)

Sets the map whose methods the translator will invoke.

Parameters:

map - new map of token/value bindings

translate

public String translate(String token)

Returns a replacement string for the original token string.

Translates the given token with the value obtained map.get call, using the token as the key.

Parameters:

token - original token string

Returns:

replacement string