net.sf.mmm.util.text.base
Class TransformerRule

java.lang.Object
  net.sf.mmm.util.text.base.TransformerRule

Direct Known Subclasses:

SuffixTransformerRule

public abstract class TransformerRule
extends Object

This is the abstract base class for a rule used to replace a given string.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

TransformerRule()

Method Summary

abstract String

transform(String string, String stringLowerCase)

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformerRule

public TransformerRule()

Method Detail

transform

public abstract String transform(String string,
                                 String stringLowerCase)

Parameters:

string - is the original string to modify.

stringLowerCase - is the string in lower-case.

Returns:

the replaced string or null if this rule does NOT apply and the string should NOT be replaced.

See Also:

Singularizer.transform(String)