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 Object

implements Substitution

Untamed: StringSubstitution implements a Substitution consisting of a simple literal string. This class is intended for use with Util.substitute.

Version:

$Id: StringSubstitution.java,v 1.4 2001/12/02 06:01:41 markm Exp $

Author:

Daniel F. Savarese

See Also:

Substitution, Util, Util.substitute(org.apache.oro.text.regex.PatternMatcher, org.apache.oro.text.regex.Pattern, org.apache.oro.text.regex.Substitution, java.lang.String, int), Substitution, Perl5Substitution

Field Summary

(package private) int	_subLength
(package private) String	_substitution

Constructor Summary

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

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

Method Summary

void	appendSubstitution(StringBuffer appendBuffer, MatchResult match, int substitutionCount, String originalInput, PatternMatcher matcher, Pattern pattern) Enabled: Appends the substitution to a buffer containing the original input with substitutions applied for the pattern matches found so far.
String	getSubstitution() Enabled: Returns the string substitution represented by this object.
void	setSubstitution(String substitution) Enabled: Sets the substitution represented by this StringSubstitution.
String	toString() Suppressed: Returns the same value as getSubstitution().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_subLength

int _subLength

_substitution

String _substitution

Constructor Detail

StringSubstitution

public StringSubstitution()

Enabled: Default constructor initializing substitution to a zero length String.

StringSubstitution

public StringSubstitution(String substitution)

Enabled: Creates a StringSubstitution representing the given string.

Parameters:

substitution - The string to use as a substitution.

Method Detail

setSubstitution

public void setSubstitution(String substitution)

Enabled: 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 String getSubstitution()

Enabled: Returns the string substitution represented by this object.

Returns:

The string substitution represented by this object.

toString

public String toString()

Suppressed: Returns the same value as getSubstitution().

Overrides:

toString in class Object

Returns:

The string substitution represented by this object.

appendSubstitution

public void appendSubstitution(StringBuffer appendBuffer,
                               MatchResult match,
                               int substitutionCount,
                               String originalInput,
                               PatternMatcher matcher,
                               Pattern pattern)

Enabled: 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.

Specified by:

appendSubstitution in interface Substitution

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.

matcher - The PatternMatcher used to find the current match.

pattern - The Pattern used to find the current match.