com.sshtools.daemon.util

Class 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.
Version:
$Id: StringExaminer.java,v 1.7 2003/09/11 15:37:07 martianx Exp $
Author:
Manfred Duchrow

Field Summary

Fields inherited from class com.sshtools.daemon.util.StringScanner

END_REACHED, buffer, length, pos_marker, position

Constructor Summary

StringExaminer(String stringToExamine)
Initialize the new instance with the string to examine.
StringExaminer(String stringToExamine, boolean ignoreCase)
Initialize the new instance with the string to examine.

Method Summary

protected boolean
charsAreEqual(char char1, char char2)
protected boolean
ignoreCase()
protected void
ignoreCase(boolean newValue)
String
peekUpToEnd()
Returns the a string containing all characters from the current position up to the end of the examined string.
boolean
skipAfter(String matchString)
Increments the position pointer up to the last character that matched the character sequence in the given matchString.
boolean
skipBefore(String matchString)
Increments the position pointer up to the first character before the character sequence in the given matchString.
String
upToEnd()
Returns the a string containing all characters from the current position up to the end of the examined string.
protected String
upToEnd(boolean peek)
Returns the a string containing all characters from the current position up to the end of the examined string.

Methods inherited from class com.sshtools.daemon.util.StringScanner

atEnd, endNotReached, endReached, getPosition, hasNext, length, markPosition, nextChar, nextNoneWhitespaceChar, peek, restorePosition, setPosition, skip, toString

Constructor Details

StringExaminer

public StringExaminer(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(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

Method Details

charsAreEqual

protected boolean charsAreEqual(char char1,
                                char char2)
Parameters:
char1 -
char2 -
Returns:

ignoreCase

protected boolean ignoreCase()
Returns:

ignoreCase

protected void ignoreCase(boolean newValue)
Parameters:
newValue -

peekUpToEnd

public 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.
Returns:

skipAfter

public boolean skipAfter(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
Returns:

skipBefore

public boolean skipBefore(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
Returns:

upToEnd

public 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.
Returns:

upToEnd

protected 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.
Parameters:
peek -
Returns:

Copyright © 2002-2003 Lee David Painter & Contributors. All Rights Reserved.