net.pandoragames.far

Class ReplacementString

java.lang.Object

net.pandoragames.far.ReplacementString

All Implemented Interfaces:

java.lang.Cloneable

public class ReplacementString
extends java.lang.Object
implements java.lang.Cloneable

Represents a replacement string for use with regex patterns. Such strings may contain references to capturing groups in the pattern of the form 'x#', where 'x' stands for some character called the "group reference indicator" and # is a sequence of digits.

Unless specified otherwise, the default group reference indicator is '$'. It may be escaped using the backslash '\' and will appear as such in the canonical string of this object. However, instead of escaping '$', other characters may be used as group reference indicator, typically the backslash it self is used for this purpose.

Author:

Olivier Wehner at 23.02.2008

Constructor Summary

Constructors

Constructor and Description
ReplacementString(java.lang.String replacementString) Creates a new ReplacementString with the specified pattern and the current default group reference indicator.
ReplacementString(java.lang.String replacementString, char groupReference) Creates a new ReplacementString with the specified pattern and group reference indicator.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a copy of this object.
boolean	doesApply(java.util.regex.Pattern pattern) Verifies that this replacement string may be applied to the regex pattern.
boolean	equals(java.lang.Object o)
java.lang.String	getCanonicalString() Returns the canonical form of this replacement string object using '$' as group reference indicator.
char	getGroupReferenceIndicator() Returns the group reference indicator that was used in the original replacement string.
int	getMaxGroupReference() Returns the highest group reference in the replacement pattern.
java.lang.String	getOriginalString() Returns the replacement string as it was supplied with the constructor.
int	hashCode()
static void	setDefaultGroupReferenceIndicator(char groupReference) Sets the default group reference indicator that applies for new instances created with the single argument constructor.
java.lang.String	toString() Returns a string representation of this object, actually the canonical form of the replacement string.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReplacementString

public ReplacementString(java.lang.String replacementString)

Creates a new ReplacementString with the specified pattern and the current default group reference indicator. The use of this constructor in multi thread environments is strongly discouraged, as the default group reference indicator may be changed by another thread any time.

Parameters:

replacementString - with capturing group references

ReplacementString

public ReplacementString(java.lang.String replacementString,
                 char groupReference)

Creates a new ReplacementString with the specified pattern and group reference indicator. Letters, digits or whitespace are not allowed as group reference indicator.

Parameters:

replacementString - with capturing group references

groupReference - group reference indicator

Method Detail

setDefaultGroupReferenceIndicator

public static void setDefaultGroupReferenceIndicator(char groupReference)

Sets the default group reference indicator that applies for new instances created with the single argument constructor. Letters, digits or whitespace are not allowed as group reference indicator.

Parameters:

groupReference - default group reference indicator

doesApply

public boolean doesApply(java.util.regex.Pattern pattern)

Verifies that this replacement string may be applied to the regex pattern. The method fails if the highest group reference in the replacement string exceeds the number of capturing groups defined in the pattern

Parameters:

pattern - possibly containing capturing groups

Returns:

true if replacement may be applied to pattern

getMaxGroupReference

public int getMaxGroupReference()

Returns the highest group reference in the replacement pattern.

Returns:

highest group reference in the replacement pattern

getCanonicalString

public java.lang.String getCanonicalString()

Returns the canonical form of this replacement string object using '$' as group reference indicator.

Returns:

canonical replacement string

getOriginalString

public java.lang.String getOriginalString()

Returns the replacement string as it was supplied with the constructor.

Returns:

original replacement string

getGroupReferenceIndicator

public char getGroupReferenceIndicator()

Returns the group reference indicator that was used in the original replacement string.

Returns:

group reference indicator

toString

public java.lang.String toString()

Returns a string representation of this object, actually the canonical form of the replacement string.

Overrides:

toString in class java.lang.Object

Returns:

string representation of this object

clone

public java.lang.Object clone()

Returns a copy of this object.

Overrides:

clone in class java.lang.Object

See Also:

Object.clone()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object