public abstract class Substitutor extends Object
(Logical) Interface for substitution strategies. (It happens to be implemented as a Java abstract class to allow future additions to be made without breaking backwards compatibility.)
Usage: When Digester.setSubstitutor(org.apache.commons.digester3.Substitutor) is set, Digester calls the methods in this interface to
create substitute values which will be passed into the Rule implementations. Of course, it is perfectly acceptable
for implementations not to make substitutions and simply return the inputs.
Different strategies are supported for attributes and body text.
| Constructor and Description |
|---|
Substitutor() |
| Modifier and Type | Method and Description |
|---|---|
abstract Attributes |
substitute(Attributes attributes)
Substitutes the attributes (before they are passed to the
Rule implementations's). |
abstract String |
substitute(String bodyText)
Substitutes for the body text.
|
public Substitutor()
public abstract Attributes substitute(Attributes attributes)
Substitutes the attributes (before they are passed to the Rule implementations's).
Digester will only call this method a second time once the original Attributes instance
can be safely reused. The implementation is therefore free to reuse the same Attributes instance for
all calls.
attributes - the Attributes passed into Digester by the SAX parser, not null (but
may be empty)Attributes to be passed to the Rule implementations. This method may pass back
the Attributes passed in. Not null but possibly empty.public abstract String substitute(String bodyText)
bodyText - the body text (as passed to Digester)Rule implementationsCopyright © 2001-2013 The Apache Software Foundation. All Rights Reserved.