com.hp.util.format

Class ReflectionTranslator

java.lang.Object

com.hp.util.format.InvalidTokenTranslator

com.hp.util.format.ReflectionTranslator

All Implemented Interfaces:

TokenTranslator

public class ReflectionTranslator
extends InvalidTokenTranslator

Formats message strings by substituting results of parameter-less method invocations for the specified string.

Author:

Thomas Vachuska

Field Summary

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
ReflectionTranslator() Constructs a self-reflecting reflection translator, i.e.
ReflectionTranslator(Object object) Constructs a reflection translator that will operate on the specified object.
ReflectionTranslator(Object object, int behaviour) Constructs a reflection translator that will operate on the specified object and will treat illegal tokens according to the given behaviour.

Method Summary

Modifier and Type	Method and Description
protected Method	getMethod(String name, Object o) Returns the named method declared by the class, or any superclasses, of the current object.
Object	getObject() Returns the object whose methods the reflection translator invokes.
void	setObject(Object object) Sets the object whose methods the reflection translator will invoke.
String	translate(String token) Translates the given token with the value of method invocation, where the name of the method is the same as the value of the token and the object on which it is invoked is the object currently set on this translator.

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

Constructor Detail

ReflectionTranslator

public ReflectionTranslator()

Constructs a self-reflecting reflection translator, i.e. one that uses itself as the object on which it will use reflexive translation.

ReflectionTranslator

public ReflectionTranslator(Object object)

Constructs a reflection translator that will operate on the specified object.

Parameters:

object - context object for reflection-based translation

ReflectionTranslator

public ReflectionTranslator(Object object,
                            int behaviour)

Constructs a reflection translator that will operate on the specified object and will treat illegal tokens according to the given behaviour.

Parameters:

object - context object for reflection-based translation

behaviour - behaviour for dealing with invalid values

Method Detail

getObject

public Object getObject()

Returns the object whose methods the reflection translator invokes.

Returns:

current context object

setObject

public void setObject(Object object)

Sets the object whose methods the reflection translator will invoke.

Parameters:

object - new context object

translate

public String translate(String token)

Translates the given token with the value of method invocation, where the name of the method is the same as the value of the token and the object on which it is invoked is the object currently set on this translator.

Parameters:

token - original token string

Returns:

replacement string

getMethod

protected Method getMethod(String name,
                           Object o)

Returns the named method declared by the class, or any superclasses, of the current object.

Parameters:

name - method name to fetch on the given object

o - object whose named method should be retrieved

Returns:

method or null if one not found