Package org.apache.oro.text.regex
Class StringSubstitution
java.lang.Object
org.apache.oro.text.regex.StringSubstitution
- All Implemented Interfaces:
Substitution
- Direct Known Subclasses:
Perl5Substitution
StringSubstitution implements a Substitution consisting of a simple
literal string. This class is intended for use with
Util.substitute
.- Since:
- 1.1
- Version:
- 2.0.8
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor initializing substitution to a zero length String.StringSubstitution
(String substitution) Creates a StringSubstitution representing the given string. -
Method Summary
Modifier and TypeMethodDescriptionvoid
appendSubstitution
(StringBuffer appendBuffer, MatchResult match, int substitutionCount, PatternMatcherInput originalInput, PatternMatcher matcher, Pattern pattern) Appends the substitution to a buffer containing the original input with substitutions applied for the pattern matches found so far.Returns the string substitution represented by this object.void
setSubstitution
(String substitution) Sets the substitution represented by this StringSubstitution.toString()
Returns the same value asgetSubstitution()
.
-
Constructor Details
-
StringSubstitution
public StringSubstitution()Default constructor initializing substitution to a zero length String. -
StringSubstitution
Creates a StringSubstitution representing the given string.- Parameters:
substitution
- The string to use as a substitution.
-
-
Method Details
-
setSubstitution
Sets the substitution represented by this StringSubstitution. You should use this method in order to avoid repeatedly allocating new StringSubstitutions. It is recommended that you allocate a single StringSubstitution and reuse it by using this method when appropriate.- Parameters:
substitution
- The string to use as a substitution.
-
getSubstitution
Returns the string substitution represented by this object.- Returns:
- The string substitution represented by this object.
-
toString
Returns the same value asgetSubstitution()
. -
appendSubstitution
public void appendSubstitution(StringBuffer appendBuffer, MatchResult match, int substitutionCount, PatternMatcherInput originalInput, PatternMatcher matcher, Pattern pattern) Appends the substitution to a buffer containing the original input with substitutions applied for the pattern matches found so far. SeeSubstitution.appendSubstition()
for more details regarding the expected behavior of this method.- Specified by:
appendSubstitution
in interfaceSubstitution
- Parameters:
appendBuffer
- The buffer containing the new string resulting from performing substitutions on the original input.match
- The current match causing a substitution to be made.substitutionCount
- The number of substitutions that have been performed so far by Util.substitute.originalInput
- The original input upon which the substitutions are being performed. This is a read-only parameter and is not modified.matcher
- The PatternMatcher used to find the current match.pattern
- The Pattern used to find the current match.
-