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
public class StringSubstitution extends java.lang.Object implements Substitution
StringSubstitution implements a Substitution consisting of a simple literal string. This class is intended for use withUtil.substitute
.
-
-
Constructor Summary
Constructors Constructor Description StringSubstitution()
Default constructor initializing substitution to a zero length String.StringSubstitution(java.lang.String substitution)
Creates a StringSubstitution representing the given string.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
appendSubstitution(java.lang.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.java.lang.String
getSubstitution()
Returns the string substitution represented by this object.void
setSubstitution(java.lang.String substitution)
Sets the substitution represented by this StringSubstitution.java.lang.String
toString()
Returns the same value asgetSubstitution()
.
-
-
-
Constructor Detail
-
StringSubstitution
public StringSubstitution()
Default constructor initializing substitution to a zero length String.
-
StringSubstitution
public StringSubstitution(java.lang.String substitution)
Creates a StringSubstitution representing the given string.- Parameters:
substitution
- The string to use as a substitution.
-
-
Method Detail
-
setSubstitution
public void setSubstitution(java.lang.String substitution)
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
public java.lang.String getSubstitution()
Returns the string substitution represented by this object.- Returns:
- The string substitution represented by this object.
-
toString
public java.lang.String toString()
Returns the same value asgetSubstitution()
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- The string substitution represented by this object.
-
appendSubstitution
public void appendSubstitution(java.lang.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.
-
-