jsimple.util

Class MatchBuilder

java.lang.Object

jsimple.util.MatchBuilder

public class MatchBuilder
extends java.lang.Object

Since:

1/11/2015

Constructor Summary

Constructors

Constructor and Description
MatchBuilder(java.lang.String str)
MatchBuilder(java.lang.String str, int start)

Method Summary

Modifier and Type	Method and Description
void	advance() Advance the iterator to the next character.
char	getLookahead()
boolean	hitEnd()
boolean	match(char charValue)
boolean	match(Pattern pattern)
boolean	match(java.lang.String stringValue)
boolean	matchCharRange(int minChar, int maxChar)
boolean	matchDigit() Matches a single digit (0 - 9).
boolean	matchDigits() Matches one or more digits (0 - 9).
boolean	matchRestOfString() Matches the remainder of the outer string, however much is left.
void	matchUntil(Pattern until) Matches until the specific pattern is encountered or the end of string is hit.
char	read() Return the current character (same as getLookahead()) then advance to the next one.
void	startOverAtCurrentPosition() Resets the MatchBuilder so the previous end position is now the start position for any new matching.
java.lang.String	toString() Returns the substring currently matched by this MatchBuilder.

Methods inherited from class java.lang.Object

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

Constructor Detail

MatchBuilder

public MatchBuilder(java.lang.String str,
                    int start)

MatchBuilder

public MatchBuilder(java.lang.String str)

Method Detail

toString

public java.lang.String toString()

Returns the substring currently matched by this MatchBuilder. This method is generally used to get the output of the MatchBuilder.

Overrides:

toString in class java.lang.Object

Returns:

substring currently matched

getLookahead

public char getLookahead()

Returns:

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

read

public char read()

Return the current character (same as getLookahead()) 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.

hitEnd

public boolean hitEnd()

startOverAtCurrentPosition

public void startOverAtCurrentPosition()

Resets the MatchBuilder so the previous end position is now the start position for any new matching.

matchRestOfString

public boolean matchRestOfString()

Matches the remainder of the outer string, however much is left.

Returns:

true, always

matchCharRange

public boolean matchCharRange(int minChar,
                              int maxChar)

match

public boolean match(Pattern pattern)

matchUntil

public void matchUntil(Pattern until)

Matches until the specific pattern is encountered or the end of string is hit. The pattern itself isn't included in the match; it's just used to terminate it.

matchDigit

public boolean matchDigit()

Matches a single digit (0 - 9).

Returns:

true a digit was matched

matchDigits

public boolean matchDigits()

Matches one or more digits (0 - 9).

Returns:

true if at least one digit was matched

match

public boolean match(char charValue)

match

public boolean match(java.lang.String stringValue)