Class Substitutor
- java.lang.Object
-
- org.apache.commons.digester.Substitutor
-
- Direct Known Subclasses:
VariableSubstitutor
public abstract class Substitutor extends java.lang.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.digester.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.
- Since:
- 1.6
-
-
Constructor Summary
Constructors Constructor Description Substitutor()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract java.lang.String
substitute(java.lang.String bodyText)
Substitutes for the body text.abstract org.xml.sax.Attributes
substitute(org.xml.sax.Attributes attributes)
Substitutes the attributes (before they are passed to theRule
implementations's).
-
-
-
Method Detail
-
substitute
public abstract org.xml.sax.Attributes substitute(org.xml.sax.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 originalAttributes
instance can be safely reused. The implementation is therefore free to reuse the sameAttributes
instance for all calls.- Parameters:
attributes
- theAttributes
passed intoDigester
by the SAX parser, not null (but may be empty)- Returns:
Attributes
to be passed to theRule
implementations. This method may pass back the Attributes passed in. Not null but possibly empty.
-
substitute
public abstract java.lang.String substitute(java.lang.String bodyText)
Substitutes for the body text. This method may substitute values into the body text of the elements that Digester parses.- Parameters:
bodyText
- the body text (as passed toDigester
)- Returns:
- the body text to be passed to the
Rule
implementations
-
-