com.codemesh.terp.api
Class Formatter.Remove

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

All Implemented Interfaces:

Formatter, Transformer<java.lang.CharSequence>

Enclosing interface:

Formatter

public static class Formatter.Remove
extends Formatter.AbstractFormatter

A formatter that removes a string from an item. Use this formatter to remove all instances of a substring from a larger string.

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.Remove()

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.Remove

public Formatter.Remove()

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. args is expected to contain at least one argument, whose string representation is to be removed from the item that is being transformed.

Parameters:

item - the item to transform.

args - the optional arguments.

ctx - the context in which the transformation occurs.

Returns:

the transformed item.