net.sf.mmm.util.transformer.api

Interface StringTransformerRule

All Superinterfaces:

Transformer<String>

All Known Implementing Classes:

RegexStringTransformerRule

public interface StringTransformerRule
extends Transformer<String>

This is the interface for a Transformer of Strings that is typically used as part of a StringTransformerChain.

Since:

1.0.2

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
boolean	isStopOnMatch() This method determines if this rule will stop further proceeding if it matched.

Methods inherited from interface net.sf.mmm.util.transformer.api.Transformer

transform

Method Detail

isStopOnMatch

boolean isStopOnMatch()

This method determines if this rule will stop further proceeding if it matched. Since the flow of proceeding is performed outside of this transformer rule, the caller needs to identify if this rule matched. This is done via the convention that the rule returns the original value in transform if it did NOT match.
If you are familiar with apache httpd you can think of this flag as the "L" in a rewrite rule.

Returns:

true if the rule should stop further proceeding after successful transformation.