de.unkrig.commons.text

Class StringStream<EX extends Throwable>

java.lang.Object

de.unkrig.commons.text.StringStream<EX>

Type Parameters:

EX - The exception type that the delegate ProducerWhichThrows may throw

public class StringStream<EX extends Throwable>
extends Object

An entity that allows REGEX-based analysis of the products of a delegate ProducerWhichThrows<String>.

A "null" product is interpreted as the "end-of-input" condition.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StringStream.UnexpectedElementException Indication that a string is not as expected.

Constructor Summary

Constructors

Constructor and Description
StringStream(ProducerWhichThrows<? extends String,? extends EX> producer)
StringStream(ProducerWhichThrows<? extends String,? extends EX> producer, String unexpectedElementExceptionMessagePrefix)

Method Summary

Modifier and Type	Method and Description
boolean	atEnd()
String	group(int group)
String	peek()
boolean	peek(Pattern pattern)
boolean	peek(String expected)
boolean	peekRead(Pattern pattern) Consumes the next string iff it matches the given pattern.
int	peekRead(String... expected) Consumes the next string iff it equals one of the expected strings.
boolean	peekRead(String expected) Consumes the next string iff it equals the expected string.
String	read() Verifies that the next string is not null, and consumes it.
void	read(Pattern pattern) Verifies that the next string matches the given pattern.
void	read(String expected) Verifies that the next string equals the given expected string, and consumes it.
String[]	readRest() Consumes and returns all remaining elements.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringStream

public StringStream(ProducerWhichThrows<? extends String,? extends EX> producer)

See Also:

StringStream

StringStream

public StringStream(ProducerWhichThrows<? extends String,? extends EX> producer,
                    @Nullable
                    String unexpectedElementExceptionMessagePrefix)

See Also:

StringStream

Method Detail

atEnd

public boolean atEnd()
              throws EX extends Throwable

Returns:

The next string, without consuming it

Throws:

EX extends Throwable

peek

public String peek()
            throws EX extends Throwable,
                   StringStream.UnexpectedElementException

Returns:

The next string, without consuming it

Throws:

StringStream.UnexpectedElementException - The next string was null

EX extends Throwable

peek

public boolean peek(String expected)
             throws EX extends Throwable

Returns:

Whether the next string equals expected

Throws:

EX extends Throwable

peek

public boolean peek(Pattern pattern)
             throws EX extends Throwable

Returns:

Whether the next string matches the pattern

Throws:

EX extends Throwable

peekRead

public boolean peekRead(@Nullable
                        String expected)
                 throws EX extends Throwable

Consumes the next string iff it equals the expected string.

Returns:

Whether the next string equals the expected string

Throws:

EX extends Throwable

peekRead

public boolean peekRead(@Nullable
                        Pattern pattern)
                 throws EX extends Throwable

Consumes the next string iff it matches the given pattern.

Returns:

Whether the next string matches the pattern

Throws:

EX extends Throwable

See Also:

group(int)

peekRead

public int peekRead(String... expected)
             throws EX extends Throwable

Consumes the next string iff it equals one of the expected strings.

Returns:

The index of the equl string, or -1

Throws:

EX extends Throwable

read

public String read()
            throws StringStream.UnexpectedElementException,
                   EX extends Throwable

Verifies that the next string is not null, and consumes it.

Throws:

StringStream.UnexpectedElementException - The next string is null

EX extends Throwable

read

public void read(String expected)
          throws StringStream.UnexpectedElementException,
                 EX extends Throwable

Verifies that the next string equals the given expected string, and consumes it.

Throws:

StringStream.UnexpectedElementException - The next string does equal the expected string

EX extends Throwable

read

public void read(Pattern pattern)
          throws EX extends Throwable,
                 StringStream.UnexpectedElementException

Verifies that the next string matches the given pattern.

Throws:

StringStream.UnexpectedElementException - The next string does match the pattern

EX extends Throwable

readRest

public String[] readRest()
                  throws EX extends Throwable

Consumes and returns all remaining elements.

Throws:

EX extends Throwable

group

@Nullable
public String group(int group)

Returns:

The (possibly empty) subsequence captured by the group during the previous read(Pattern), peek(Pattern) or peekRead(Pattern) operation, or null if the group failed to match part of the input

See Also:

Matcher.group(int)