org.apache.oro.text.regex

Class StringSubstitution

public class StringSubstitution extends Object implements Substitution

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: Substitution Util Util Substitution Perl5Substitution

Constructor Summary
StringSubstitution()
Default constructor initializing substitution to a zero length String.
StringSubstitution(String substitution)
Creates a StringSubstitution representing the given string.
Method Summary
voidappendSubstitution(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.
StringgetSubstitution()
Returns the string substitution represented by this object.
voidsetSubstitution(String substitution)
Sets the substitution represented by this StringSubstitution.
StringtoString()
Returns the same value as getSubstitution.

Constructor Detail

StringSubstitution

public StringSubstitution()
Default constructor initializing substitution to a zero length String.

StringSubstitution

public StringSubstitution(String substitution)
Creates a StringSubstitution representing the given string.

Parameters: substitution The string to use as a substitution.

Method Detail

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. See Substitution.appendSubstition() for more details regarding the expected behavior of this method.

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.

getSubstitution

public String getSubstitution()
Returns the string substitution represented by this object.

Returns: The string substitution represented by this object.

setSubstitution

public void setSubstitution(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.

toString

public String toString()
Returns the same value as getSubstitution.

Returns: The string substitution represented by this object.

Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.