org.pfsw.text
Class StringExaminer

java.lang.Object
  org.pfsw.text.StringScanner
      org.pfsw.text.StringExaminer

public class StringExaminer
extends StringScanner

As a subclass of StringScanner this class allows more advanced navigation over the underlying string.
That includes moving to positions of specific substrings etc.

StringExaminer

public StringExaminer(java.lang.String stringToExamine)

Initialize the new instance with the string to examine.
The string will be treated case-sensitive.

Parameters:

stringToExamine - The string that should be examined

StringExaminer

public StringExaminer(java.lang.String stringToExamine,
                      boolean ignoreCase)

Initialize the new instance with the string to examine.

Parameters:

stringToExamine - The string that should be examined

ignoreCase - Specified whether or not treating the string case insensitive

skipAfter

public boolean skipAfter(java.lang.String matchString)

Increments the position pointer up to the last character that matched the character sequence in the given matchString. Returns true, if the matchString was found, otherwise false.

If the matchString was found, the next invocation of method nextChar() returns the first character after that matchString.

Parameters:

matchString - The string to look up

findPositionOf

public int findPositionOf(java.lang.String matchString)

Returns the position index of the given match string starting to look for it from the current position. If the given string cannot be found -1 will be returned. This method does not change the position counter.

skipBefore

public boolean skipBefore(java.lang.String matchString)

Increments the position pointer up to the first character before the character sequence in the given matchString. Returns true, if the matchString was found, otherwise false.

If the matchString was found, the next invocation of method nextChar() returns the first character of that matchString from the position where it was found inside the examined string.

Parameters:

matchString - The string to look up

peekUpToEnd

public java.lang.String peekUpToEnd()

Returns the a string containing all characters from the current position up to the end of the examined string.
The character position of the examiner is not changed by this method.

upToEnd

public java.lang.String upToEnd()

Returns the a string containing all characters from the current position up to the end of the examined string.
The character position is put to the end by this method. That means the next invocation of nextChar() returns END_REACHED.

peekUpToPosition

public java.lang.String peekUpToPosition(int pos)

Returns the a string containing all characters from the current position up to the specified position of the examined string.
The character position of the examiner after calling this method is pos.

upToPosition

public java.lang.String upToPosition(int pos)

Returns the a string containing all characters from the current position up to the specified position of the examined string.
The character position of the examiner after calling this method is unchanged.

appendUpToPosition

public void appendUpToPosition(java.lang.StringBuffer strBuffer,
                               int pos)

Appends all characters from the current position up to the specified position of the examined string to the given buffer.
The character position of the examiner after calling this method is pos.

charsAreEqual

protected boolean charsAreEqual(char char1,
                                char char2)

upToEnd

protected java.lang.String upToEnd(boolean peek)

Returns the a string containing all characters from the current position up to the end of the examined string.
Depending on the peek flag the character position of the examiner is unchanged (true) after calling this method or points behind the strings last character.

appendUpToPosition

protected void appendUpToPosition(java.lang.StringBuffer strBuffer,
                                  int pos,
                                  boolean peek)

Returns the a string containing all characters from the current position up to the specified position of the examined string.
Depending on the peek flag the character position of the examiner is unchanged (true) after calling this method or points to pos.

ignoreCase

protected boolean ignoreCase()

ignoreCase

protected void ignoreCase(boolean newValue)