com.codemesh.terp.api
Class Transformer.AbstractTransformer<T>

java.lang.Object
  com.codemesh.terp.api.Transformer.AbstractTransformer<T>

All Implemented Interfaces:

Transformer<T>

Direct Known Subclasses:

Formatter.AbstractFormatter, Scalar.AbstractScalarTransformer, Transformer.LineBreaker

Enclosing interface:

Transformer<T>

public abstract static class Transformer.AbstractTransformer<T>
extends java.lang.Object
implements Transformer<T>

Nested Class Summary

Nested classes/interfaces inherited from interface com.codemesh.terp.api.Transformer

Transformer.AbstractTransformer<T>, Transformer.LineBreaker

Field Summary

Fields inherited from interface com.codemesh.terp.api.Transformer

NO_ARGS, NO_PARAM_NAMES

Constructor Summary

Transformer.AbstractTransformer()

Transformer.AbstractTransformer(java.lang.String itemName)

Transformer.AbstractTransformer(java.lang.String itemName, java.lang.String[] paramNames)

Method Summary

java.lang.String	getItemName() Returns the name used for the item that is being transformed.
java.lang.String[]	getParamNames() Returns the parameter names.
T	transform(java.lang.Object item) Transforms an item into another item of a specified type.
T	transform(java.lang.Object item, java.util.List<java.lang.Object> args) Transforms an item into another item, taking optional arguments into account.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.codemesh.terp.api.Transformer

transform

Constructor Detail

Transformer.AbstractTransformer

public Transformer.AbstractTransformer()

Transformer.AbstractTransformer

public Transformer.AbstractTransformer(java.lang.String itemName)

Transformer.AbstractTransformer

public Transformer.AbstractTransformer(java.lang.String itemName,
                                       java.lang.String[] paramNames)

Method Detail

getItemName

public java.lang.String getItemName()

Description copied from interface: Transformer

Returns the name used for the item that is being transformed.

Specified by:

getItemName in interface Transformer<T>

Returns:

a name.

getParamNames

public java.lang.String[] getParamNames()

Description copied from interface: Transformer

Returns the parameter names.

Specified by:

getParamNames in interface Transformer<T>

Returns:

an array of names.

transform

public T transform(java.lang.Object item)

Description copied from interface: Transformer

Transforms an item into another item of a specified type.

Specified by:

transform in interface Transformer<T>

Parameters:

item - the item to transform.

Returns:

the transformed item.

transform

public T transform(java.lang.Object item,
                   java.util.List<java.lang.Object> args)

Description copied from interface: Transformer

Transforms an item into another item, taking optional arguments into account.

Specified by:

transform in interface Transformer<T>

Parameters:

item - the item to transform.

args - the optional arguments.

Returns:

the transformed item.