org.apache.oro.text.regex
Class PatternMatcherInput

java.lang.Object
  |
  +--org.apache.oro.text.regex.PatternMatcherInput

public final class PatternMatcherInput

extends Object

Safe:

Field Summary

(package private) int	_beginOffset
(package private) int	_currentOffset
(package private) int	_endOffset
(package private) int	_matchBeginOffset
(package private) int	_matchEndOffset
(package private) char[]	_originalBuffer
(package private) char[]	_originalCharInput
(package private) String	_originalStringInput
(package private) char[]	_toLowerBuffer

Constructor Summary

PatternMatcherInput(char[] input)
Enabled: Like calling:

PatternMatcherInput(char[] input, int begin, int length)
Enabled: Creates a PatternMatcherInput object, associating a region of a string (represented as a char[]) as input to be used for pattern matching by PatternMatcher objects.

PatternMatcherInput(String input)
Enabled: Like calling

PatternMatcherInput(String input, int begin, int length)
Enabled: Creates a PatternMatcherInput object, associating a region of a String as input to be used for pattern matching by PatternMatcher objects.

Method Summary

char	charAt(int offset) Enabled: Returns the character at a particular offset relative to the begin offset of the input.
boolean	endOfInput() Enabled: Returns whether or not the end of the input has been reached.
int	getBeginOffset() Enabled: @return The offset of the input that should be considered the start of the region to be considered as input by PatternMatcher methods.
char[]	getBuffer() Enabled: Retrieves the char[] buffer to be used used as input by PatternMatcher implementations to look for matches.
int	getCurrentOffset() Enabled: @return The offset of the input that should be considered the current offset where PatternMatcher methods should start looking for matches.
int	getEndOffset() Enabled: @return The offset of the input that should be considered the end of the region to be considered as input by PatternMatcher methods.
Object	getInput() Enabled: Retrieves the original input used to initialize the PatternMatcherInput instance.
int	getMatchBeginOffset() Enabled: Returns the offset marking the beginning of the match found by contains().
int	getMatchEndOffset() Enabled: Returns the offset marking the end of the match found by contains().
int	length() Enabled: @return The length of the region to be considered input for pattern matching purposes.
String	match() Enabled: A convenience method returning the part of the input corresponding to the last match found by a call to a Perl5Matcher contains method.
String	postMatch() Enabled: A convenience method returning the part of the input occurring after the last match found by a call to a Perl5Matcher contains method.
String	preMatch() Enabled: A convenience method returning the part of the input occurring before the last match found by a call to a Perl5Matcher contains method.
void	setBeginOffset(int offset) Enabled: Sets the offset of the input that should be considered the start of the region to be considered as input by PatternMatcher methods.
void	setCurrentOffset(int offset) Enabled: Sets the offset of the input that should be considered the current offset where PatternMatcher methods should start looking for matches.
void	setEndOffset(int offset) Enabled: Sets the offset of the input that should be considered the end of the region to be considered as input by PatternMatcher methods.
void	setInput(char[] input) Enabled: This method is identical to calling:
void	setInput(char[] input, int begin, int length) Enabled: Associates a region of a string (represented as a char[]) as input to be used for pattern matching by PatternMatcher objects.
void	setInput(String input) Enabled: This method is identical to calling:
void	setInput(String input, int begin, int length) Enabled: Associates a region of a String as input to be used for pattern matching by PatternMatcher objects.
void	setMatchOffsets(int matchBeginOffset, int matchEndOffset) Enabled: This method is intended for use by PatternMatcher implementations.
String	substring(int beginOffset) Enabled: Returns a new string that is a substring of the PatternMatcherInput instance.
String	substring(int beginOffset, int endOffset) Enabled: Returns a new string that is a substring of the PatternMatcherInput instance.
String	toString() Suppressed: Returns the string representation of the input, where the input is considered to start from the begin offset and end at the end offset.

Methods inherited from class java.lang.Object

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

Field Detail

_originalStringInput

String _originalStringInput

_originalCharInput

char[] _originalCharInput

_originalBuffer

char[] _originalBuffer

_toLowerBuffer

char[] _toLowerBuffer

_beginOffset

int _beginOffset

_endOffset

int _endOffset

_currentOffset

int _currentOffset

_matchBeginOffset

int _matchBeginOffset

_matchEndOffset

int _matchEndOffset

Constructor Detail

PatternMatcherInput

public PatternMatcherInput(String input,
                           int begin,
                           int length)

Enabled: Creates a PatternMatcherInput object, associating a region of a String as input to be used for pattern matching by PatternMatcher objects. A copy of the string is not made, therefore you should not modify the string unless you know what you are doing. The current offset of the PatternMatcherInput is set to the begin offset of the region.

Parameters:

input - The input to associate with the PatternMatcherInput.

begin - The offset into the char[] to use as the beginning of the input.

length - The length of the reegion starting from the begin offset to use as the input for pattern matching purposes.

PatternMatcherInput

public PatternMatcherInput(String input)

Enabled: Like calling

 PatternMatcherInput(input, 0, input.length());
 

Parameters:

input - The input to associate with the PatternMatcherInput.

PatternMatcherInput

public PatternMatcherInput(char[] input,
                           int begin,
                           int length)

Enabled: Creates a PatternMatcherInput object, associating a region of a string (represented as a char[]) as input to be used for pattern matching by PatternMatcher objects. A copy of the string is not made, therefore you should not modify the string unless you know what you are doing. The current offset of the PatternMatcherInput is set to the begin offset of the region.

Parameters:

input - The input to associate with the PatternMatcherInput.

begin - The offset into the char[] to use as the beginning of the input.

length - The length of the reegion starting from the begin offset to use as the input for pattern matching purposes.

PatternMatcherInput

public PatternMatcherInput(char[] input)

Enabled: Like calling:

 PatternMatcherInput(input, 0, input.length);
 

Parameters:

input - The input to associate with the PatternMatcherInput.

Method Detail

length

public int length()

Enabled: @return The length of the region to be considered input for pattern matching purposes. Essentially this is then end offset minus the begin offset.

setInput

public void setInput(String input,
                     int begin,
                     int length)

Enabled: Associates a region of a String as input to be used for pattern matching by PatternMatcher objects. The current offset of the PatternMatcherInput is set to the begin offset of the region.

Parameters:

input - The input to associate with the PatternMatcherInput.

begin - The offset into the String to use as the beginning of the input.

length - The length of the reegion starting from the begin offset to use as the input for pattern matching purposes.

setInput

public void setInput(String input)

Enabled: This method is identical to calling:

 setInput(input, 0, input.length());
 

Parameters:

input - The input to associate with the PatternMatcherInput.

setInput

public void setInput(char[] input,
                     int begin,
                     int length)

Enabled: Associates a region of a string (represented as a char[]) as input to be used for pattern matching by PatternMatcher objects. A copy of the string is not made, therefore you should not modify the string unless you know what you are doing. The current offset of the PatternMatcherInput is set to the begin offset of the region.

Parameters:

input - The input to associate with the PatternMatcherInput.

begin - The offset into the char[] to use as the beginning of the input.

length - The length of the reegion starting from the begin offset to use as the input for pattern matching purposes.

setInput

public void setInput(char[] input)

Enabled: This method is identical to calling:

 setInput(input, 0, input.length);
 

Parameters:

input - The input to associate with the PatternMatcherInput.

charAt

public char charAt(int offset)

Enabled: Returns the character at a particular offset relative to the begin offset of the input.

Parameters:

offset - The offset at which to fetch a character (relative to the beginning offset.

Returns:

The character at a particular offset.

substring

public String substring(int beginOffset,
                        int endOffset)

Enabled: Returns a new string that is a substring of the PatternMatcherInput instance. The substring begins at the specified beginOffset relative to the begin offset and extends to the specified endOffset - 1 relative to the begin offset of the PatternMatcherInput instance.

Parameters:

beginOffset - The offset relative to the begin offset of the PatternMatcherInput at which to start the substring (inclusive).

endOffset - The offset relative to the begin offset of the PatternMatcherInput at which to end the substring (exclusive).

Returns:

The specified substring.

substring

public String substring(int beginOffset)

Enabled: Returns a new string that is a substring of the PatternMatcherInput instance. The substring begins at the specified beginOffset relative to the begin offset and extends to the end offset of the PatternMatcherInput.

Parameters:

beginOffset - The offset relative to the begin offset of the PatternMatcherInput at which to start the substring.

Returns:

The specified substring.

getInput

public Object getInput()

Enabled: Retrieves the original input used to initialize the PatternMatcherInput instance. If a String was used, the String instance will be returned. If a char[] was used, a char instance will be returned. This violates data encapsulation and hiding principles, but it is a great convenience for the programmer.

Returns:

The String or char[] input used to initialize the PatternMatcherInput instance.

getBuffer

public char[] getBuffer()

Enabled: Retrieves the char[] buffer to be used used as input by PatternMatcher implementations to look for matches. This array should be treated as read only by the programmer.

Returns:

The char[] buffer to be used as input by PatternMatcher implementations.

endOfInput

public boolean endOfInput()

Enabled: Returns whether or not the end of the input has been reached.

Returns:

True if the current offset is greater than or equal to the end offset.

getBeginOffset

public int getBeginOffset()

Enabled: @return The offset of the input that should be considered the start of the region to be considered as input by PatternMatcher methods.

getEndOffset

public int getEndOffset()

Enabled: @return The offset of the input that should be considered the end of the region to be considered as input by PatternMatcher methods. This offset is actually 1 plus the last offset that is part of the input region.

getCurrentOffset

public int getCurrentOffset()

Enabled: @return The offset of the input that should be considered the current offset where PatternMatcher methods should start looking for matches.

setBeginOffset

public void setBeginOffset(int offset)

Enabled: Sets the offset of the input that should be considered the start of the region to be considered as input by PatternMatcher methods. In other words, everything before this offset is ignored by a PatternMatcher.

Parameters:

offset - The offset to use as the beginning of the input.

setEndOffset

public void setEndOffset(int offset)

Enabled: Sets the offset of the input that should be considered the end of the region to be considered as input by PatternMatcher methods. This offset is actually 1 plus the last offset that is part of the input region.

Parameters:

offset - The offset to use as the end of the input.

setCurrentOffset

public void setCurrentOffset(int offset)

Enabled: Sets the offset of the input that should be considered the current offset where PatternMatcher methods should start looking for matches. Also resets all match offset information to -1. By calling this method, you invalidate all previous match information. Therefore a PatternMatcher implementation must call this method before setting match offset information.

Parameters:

offset - The offset to use as the current offset.

toString

public String toString()

Suppressed: Returns the string representation of the input, where the input is considered to start from the begin offset and end at the end offset.

Overrides:

toString in class Object

Returns:

The string representation of the input.

preMatch

public String preMatch()

Enabled: A convenience method returning the part of the input occurring before the last match found by a call to a Perl5Matcher contains method.

Returns:

The input preceeding a match.

postMatch

public String postMatch()

Enabled: A convenience method returning the part of the input occurring after the last match found by a call to a Perl5Matcher contains method.

Returns:

The input succeeding a contains() match.

match

public String match()

Enabled: A convenience method returning the part of the input corresponding to the last match found by a call to a Perl5Matcher contains method. The method is not called getMatch() so as not to confuse it with Perl5Matcher's getMatch() which returns a MatchResult instance and also for consistency with preMatch() and postMatch().

Returns:

The input consisting of the match found by contains().

setMatchOffsets

public void setMatchOffsets(int matchBeginOffset,
                            int matchEndOffset)

Enabled: This method is intended for use by PatternMatcher implementations. It is necessary to record the location of the previous match so that consecutive contains() matches involving null string matches are properly handled. If you are not implementing a PatternMatcher, forget this method exists. If you use it outside of its intended context, you will only disrupt the stored state.

As a note, the preMatch(), postMatch(), and match() methods are provided as conveniences because PatternMatcherInput must store match offset information to completely preserve state for consecutive PatternMatcher contains() matches.

Parameters:

matchBeginOffset - The begin offset of a match found by contains().

matchEndOffset - The end offset of a match found by contains().

getMatchBeginOffset

public int getMatchBeginOffset()

Enabled: Returns the offset marking the beginning of the match found by contains().

Returns:

The begin offset of a contains() match.

getMatchEndOffset

public int getMatchEndOffset()

Enabled: Returns the offset marking the end of the match found by contains().

Returns:

The end offset of a contains() match.