StringPeekerator (commons-util 1.2.13-SNAPSHOT API)

java.lang.Object
- de.unkrig.commons.util.collections.StringPeekerator

All Implemented Interfaces:

Peekerator<String>, Iterator<String>
```
public class StringPeekerator
extends Object
implements Peekerator<String>
```
Extends a Peekerator<String> with various methods that check for string equality or pattern matching.
Notice that null is a perfectly valid element value, and all methods handle null values in a defined manner.

See Also:

StringStream, AbstractParser

Constructor Summary

Constructors
Constructor and Description
`StringPeekerator(Iterator<String> delegate)` Equivalent with `new StringPeekerator(Peekerators.from(delegate))`.
`StringPeekerator(ListIterator<String> delegate)` Equivalent with `new StringPeekerator(Peekerators.from(delegate))`.
`StringPeekerator(Peekerator<String> delegate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`hasNext()`
`String`	`next()` Consumes and returns the next element in this iteration.
`int`	`nextEquals(String... expected)` Verifies that the next element equals any of the `expected` strings, and consumes it.
`void`	`nextEquals(String expected)` Verifies that the next element equals the `expected` string, and consumes it.
`int`	`nextEqualsIgnoreCase(String... expected)` Verifies that the next element equals (ignoring case) any of the the `expected` string, and consumes it.
`void`	`nextEqualsIgnoreCase(String expected)` Verifies that the next element equals (ignoring case) the `expected` string, and consumes it.
`int`	`nextIfEquals(String... expected)` Consumes the next element iff it equals any of the `expected` strings.
`boolean`	`nextIfEquals(String expected)` Consumes the next element iff it equals the `expected` string.
`int`	`nextIfEqualsIgnoreCase(String... expected)` Consumes the next element iff it equals (ignoring case) any of the `expected` strings.
`boolean`	`nextIfEqualsIgnoreCase(String expected)` Consumes the next element iff it equals (ignoring case) the `expected` string.
`Matcher`	`nextIfMatches(Pattern pattern)` Consumes the next element iff it matches the given `pattern`.
`void`	`nextMatches(Pattern pattern)` Verifies that the next element matches the given `pattern`.
`String`	`peek()` Just like `Peekerator.next()`, but does not consume the next element.
`Matcher`	`peek(Pattern pattern)` Matches the next element against the given `pattern`, and returns the successful matcher.
`boolean`	`peek(String expected)` Checks whether the next element equals the `expected` string, but does consusme it.
`boolean`	`peekIgnoreCase(String expected)` Checks whether the next element equals (ignoring case) the `expected` string, but does not consume it.
`void`	`remove()` Removes the last element returned by `Peekerator.next()` or `Peekerator.peek()` from the underlying collection.
`String[]`	`rest()` Consumes and returns all remaining elements.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator
forEachRemaining

- Constructor Detail
  - StringPeekerator
```
public StringPeekerator(Peekerator<String> delegate)
```
  - StringPeekerator
```
public StringPeekerator(Iterator<String> delegate)
```
    Equivalent with new StringPeekerator(Peekerators.from(delegate)).
  - StringPeekerator
```
public StringPeekerator(ListIterator<String> delegate)
```
    Equivalent with new StringPeekerator(Peekerators.from(delegate)).
- Method Detail
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<String>
  - remove
```
public void remove()
```
    Description copied from interface: Peekerator
    
    Removes the last element returned by Peekerator.next() or Peekerator.peek() from the underlying collection.
    
    Specified by:
    
    remove in interface Peekerator<String>
    
    Specified by:
    
    remove in interface Iterator<String>
  - peek
```
public String peek()
```
    Description copied from interface: Peekerator
    
    Just like Peekerator.next(), but does not consume the next element. I.e. the next invocation of Peekerator.peek() of Peekerator.next() will return the same element that this invocation returns.
    
    Specified by:
    
    peek in interface Peekerator<String>
    
    Returns:
    
    The next element in this iteration
  - peek
```
public boolean peek(@Nullable
                    String expected)
```
    Checks whether the next element equals the expected string, but does consusme it.
    
    See Also:
    
    Object.equals(Object)
  - peekIgnoreCase
```
public boolean peekIgnoreCase(String expected)
```
    Checks whether the next element equals (ignoring case) the expected string, but does not consume it.
    
    See Also:
    
    StringUtil.equalsIgnoreCase(String, String)
  - peek
```
@Nullable
public Matcher peek(Pattern pattern)
```
    Matches the next element against the given pattern, and returns the successful matcher.
    
    Returns:
    
    null iff the next element is null, or if it does not match the pattern
  - next
```
@Nullable
public String next()
```
    Description copied from interface: Peekerator
    
    Consumes and returns the next element in this iteration.
    
    Specified by:
    
    next in interface Peekerator<String>
    
    Specified by:
    
    next in interface Iterator<String>
    
    Returns:
    
    The next element in this iteration
  - nextIfEquals
```
public boolean nextIfEquals(@Nullable
                            String expected)
```
    Consumes the next element iff it equals the expected string.
    
    Returns:
    
    Whether the next element equals the expected string
    
    See Also:
    
    ObjectUtil.equals(Object, Object)
  - nextIfEqualsIgnoreCase
```
public boolean nextIfEqualsIgnoreCase(@Nullable
                                      String expected)
```
    Consumes the next element iff it equals (ignoring case) the expected string.
    
    Returns:
    
    Whether the next element equals the expected string
    
    See Also:
    
    StringUtil.equalsIgnoreCase(String, String)
  - nextIfEquals
```
public int nextIfEquals(String... expected)
```
    Consumes the next element iff it equals any of the expected strings.
    
    Returns:
    
    The index of the first equal string, or -1
    
    See Also:
    
    Object.equals(Object)
  - nextIfEqualsIgnoreCase
```
public int nextIfEqualsIgnoreCase(String... expected)
```
    Consumes the next element iff it equals (ignoring case) any of the expected strings.
    
    Returns:
    
    The index of the first equal string, or -1
    
    See Also:
    
    StringUtil.equalsIgnoreCase(String, String)
  - nextIfMatches
```
@Nullable
public Matcher nextIfMatches(Pattern pattern)
```
    Consumes the next element iff it matches the given pattern.
    
    Returns:
    
    null if the next element is null, or does not match the given pattern
  - nextEquals
```
public void nextEquals(String expected)
```
    Verifies that the next element equals the expected string, and consumes it.
    
    Throws:
    
    NoSuchElementException - This peekerator has no more elements
    
    NoSuchElementException - The next element does equal the expected string
    
    See Also:
    
    ObjectUtil.equals(Object, Object)
  - nextEqualsIgnoreCase
```
public void nextEqualsIgnoreCase(String expected)
```
    Verifies that the next element equals (ignoring case) the expected string, and consumes it.
    
    Throws:
    
    NoSuchElementException - This peekerator has no more elements
    
    NoSuchElementException - The next element does equal the expected string
    
    See Also:
    
    StringUtil.equalsIgnoreCase(String, String)
  - nextEquals
```
public int nextEquals(String... expected)
```
    Verifies that the next element equals any of the expected strings, and consumes it.
    
    Returns:
    
    The index of the first string that equals the next element
    
    Throws:
    
    NoSuchElementException - This peekerator has no more elements
    
    NoSuchElementException - The next element does equal any of the expected strings
    
    See Also:
    
    ObjectUtil.equals(Object, Object)
  - nextEqualsIgnoreCase
```
public int nextEqualsIgnoreCase(String... expected)
```
    Verifies that the next element equals (ignoring case) any of the the expected string, and consumes it.
    
    Returns:
    
    The index of the first string that equals the next element
    
    Throws:
    
    NoSuchElementException - This peekerator has no more elements
    
    NoSuchElementException - The next element does equal any of the expected strings
    
    See Also:
    
    StringUtil.equalsIgnoreCase(String, String)
  - nextMatches
```
public void nextMatches(Pattern pattern)
```
    Verifies that the next element matches the given pattern.
    
    Throws:
    
    NoSuchElementException - This peekerator has no more elements
    
    NoSuchElementException - The next element is null
    
    NoSuchElementException - The next element does match the pattern
  - rest
```
public String[] rest()
```
    Consumes and returns all remaining elements.

Class StringPeekerator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Constructor Detail

StringPeekerator

StringPeekerator

StringPeekerator

Method Detail

hasNext

remove

peek

peek

peekIgnoreCase

peek

next

nextIfEquals

nextIfEqualsIgnoreCase

nextIfEquals

nextIfEqualsIgnoreCase

nextIfMatches

nextEquals

nextEqualsIgnoreCase

nextEquals

nextEqualsIgnoreCase

nextMatches

rest