com.codemesh.terp.api
Class Formatter.TextFormatter

java.lang.Object
  com.codemesh.terp.api.Transformer.AbstractTransformer<java.lang.CharSequence>
      com.codemesh.terp.api.Formatter.AbstractFormatter
          com.codemesh.terp.api.Formatter.TextFormatter

All Implemented Interfaces:

Formatter, Transformer<java.lang.CharSequence>

Enclosing interface:

Formatter

public static class Formatter.TextFormatter
extends Formatter.AbstractFormatter

A formatter that applies a Java format string with optional arguments to the item. A Java format string is very similar to a C printf() format, only more powerful. It supports more types and modifiers than the printf() family of functions. An example is a Date format that only renders the year: "%tY".

Nested Class Summary

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

Formatter.AbstractFormatter, Formatter.Base64, Formatter.Capitalize, Formatter.Namefy, Formatter.Pad, Formatter.Remove, Formatter.Replace, Formatter.TextFormatter, Formatter.ToAscii, Formatter.ToLowercase, Formatter.ToSlug, Formatter.ToUppercase, Formatter.ToXml, Formatter.Trim

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

Transformer.AbstractTransformer<T>, Transformer.LineBreaker

Field Summary

Fields inherited from class com.codemesh.terp.api.Formatter.AbstractFormatter

TO_INT, TO_STRING

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

NO_ARGS, NO_PARAM_NAMES

Constructor Summary

Formatter.TextFormatter(java.lang.String format)
Creates a Java text formatter with the given format string.

Formatter.TextFormatter(java.lang.String format, java.lang.String itemName)

Formatter.TextFormatter(java.lang.String format, java.lang.String itemName, java.lang.String[] paramNames)

Method Summary

java.lang.String

transform(java.lang.Object item, java.util.List<java.lang.Object> args, TerpContext ctx) Transforms an item into another item, taking optional arguments into account.

Methods inherited from class com.codemesh.terp.api.Transformer.AbstractTransformer

getItemName, getParamNames, transform, transform

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

getItemName, getParamNames, transform, transform

Constructor Detail

Formatter.TextFormatter

public Formatter.TextFormatter(java.lang.String format)

Creates a Java text formatter with the given format string.

Parameters:

format - the format string.

Formatter.TextFormatter

public Formatter.TextFormatter(java.lang.String format,
                               java.lang.String itemName)

Formatter.TextFormatter

public Formatter.TextFormatter(java.lang.String format,
                               java.lang.String itemName,
                               java.lang.String[] paramNames)

Method Detail

transform

public java.lang.String transform(java.lang.Object item,
                                  java.util.List<java.lang.Object> args,
                                  TerpContext ctx)

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

Parameters:

item - the item to transform.

args - the optional arguments.

ctx - the context in which the transformation occurs.

Returns:

the transformed item.