jsimple.util

Class StringIterator

java.lang.Object

jsimple.util.StringIterator

public class StringIterator
extends java.lang.Object

Since:

11/25/12 4:00 PM

Constructor Summary

Constructors

Constructor and Description
StringIterator(java.lang.String string)

Method Summary

Modifier and Type	Method and Description
void	advance() Advance the iterator to the next character.
void	advancePastWhitespace() Advance past any whitespace characters in the str, leaving the iterator at the first non-whitespace character following.
void	advancePastWhitespaceOnSameLine()
boolean	atEnd()
void	checkAndAdvance(char c) Verify that the current character is c, throwing an exception if it isn't, then advance to the next character.
char	curr()
int	getIndex()
java.lang.String	getRemaining()
java.lang.String	getString()
boolean	isAsciiLetter()
boolean	isDigit()
boolean	isLineBreak()
boolean	isWhitespace()
boolean	isWhitespaceOnSameLine()
boolean	match(char value)
boolean	match(char value, java.lang.StringBuilder buffer)
boolean	match(java.lang.String substring)
boolean	matchCharRange(int minChar, int maxChar, java.lang.StringBuilder buffer)
boolean	matchDigit(java.lang.StringBuilder buffer)
boolean	matchDigits(java.lang.StringBuilder buffer)
char	read() Return the current character (same as curr()) then advance to the next one.
java.lang.String	readWhitespaceDelimitedToken()
java.lang.String	readWhitespaceDelimitedTokenOnSameLine()
void	skipAheadPast(java.lang.String substr) Search for the the next occurrence of the specified substring & advance the iterator just past it.
boolean	skipAheadPastIfExists(java.lang.String substr) Search for the the next occurrence of the specified substring & advance the iterator just past it.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringIterator

public StringIterator(java.lang.String string)

Method Detail

getString

public java.lang.String getString()

getRemaining

public java.lang.String getRemaining()

getIndex

public int getIndex()

atEnd

public boolean atEnd()

curr

public char curr()

Returns:

current character or '\0' if at end of str

read

public char read()

Return the current character (same as curr()) then advance to the next one.

Returns:

current character or -1 if at end of str

advance

public void advance()

Advance the iterator to the next character. If already at the end of the str, this method is a no-op.

match

public boolean match(char value)

match

public boolean match(char value,
                     java.lang.StringBuilder buffer)

match

public boolean match(java.lang.String substring)

matchDigits

public boolean matchDigits(java.lang.StringBuilder buffer)

matchCharRange

public boolean matchCharRange(int minChar,
                              int maxChar,
                              java.lang.StringBuilder buffer)

matchDigit

public boolean matchDigit(java.lang.StringBuilder buffer)

skipAheadPast

public void skipAheadPast(java.lang.String substr)

Search for the the next occurrence of the specified substring & advance the iterator just past it. If that substring isn't found, an exception is thrown.

Parameters:

substr - substring to search for

skipAheadPastIfExists

public boolean skipAheadPastIfExists(java.lang.String substr)

Search for the the next occurrence of the specified substring & advance the iterator just past it. Return true if the substring is found, false if it isn't.

Parameters:

substr - substring to search for

Returns:

true if the substring is found

checkAndAdvance

public void checkAndAdvance(char c)

Verify that the current character is c, throwing an exception if it isn't, then advance to the next character.

Parameters:

c - character to verify that occurs at the current iterator position

isLineBreak

public boolean isLineBreak()

isWhitespace

public boolean isWhitespace()

Returns:

true if the current character is a whitespace character.

isDigit

public boolean isDigit()

isAsciiLetter

public boolean isAsciiLetter()

isWhitespaceOnSameLine

public boolean isWhitespaceOnSameLine()

advancePastWhitespace

public void advancePastWhitespace()

Advance past any whitespace characters in the str, leaving the iterator at the first non-whitespace character following.

advancePastWhitespaceOnSameLine

public void advancePastWhitespaceOnSameLine()

readWhitespaceDelimitedToken

public java.lang.String readWhitespaceDelimitedToken()

readWhitespaceDelimitedTokenOnSameLine

public java.lang.String readWhitespaceDelimitedTokenOnSameLine()