gnu.regexp
Class CharIndexedInputStream

java.lang.Object
  extended by gnu.regexp.CharIndexedInputStream
All Implemented Interfaces:
CharIndexed

 class CharIndexedInputStream
extends java.lang.Object
implements CharIndexed


Field Summary
 
Fields inherited from interface gnu.regexp.CharIndexed
OUT_OF_BOUNDS
 
Constructor Summary
CharIndexedInputStream(java.io.InputStream str, int index)
           
 
Method Summary
 char charAt(int index)
          Returns the character at the given offset past the current cursor position in the input.
 boolean isValid()
          Returns true if the most recent move() operation placed the cursor position at a valid position in the input.
 boolean move(int index)
          Shifts the input buffer by a given number of positions.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CharIndexedInputStream

CharIndexedInputStream(java.io.InputStream str,
                       int index)
Method Detail

charAt

public char charAt(int index)
Description copied from interface: CharIndexed
Returns the character at the given offset past the current cursor position in the input. The index of the current position is zero. It is possible for this method to be called with a negative index. This happens when using the '^' operator in multiline matching mode or the '\b' or '\<' word boundary operators. In any case, the lower bound is currently fixed at -2 (for '^' with a two-character newline).

Specified by:
charAt in interface CharIndexed
Parameters:
index - the offset position in the character field to examine
Returns:
the character at the specified index, or the OUT_OF_BOUNDS character defined by this interface.

move

public boolean move(int index)
Description copied from interface: CharIndexed
Shifts the input buffer by a given number of positions. Returns true if the new cursor position is valid.

Specified by:
move in interface CharIndexed

isValid

public boolean isValid()
Description copied from interface: CharIndexed
Returns true if the most recent move() operation placed the cursor position at a valid position in the input.

Specified by:
isValid in interface CharIndexed