Package dev.sympho.modular_commands.utils

Interface StringSplitter.Async.Iterator

All Superinterfaces:

Iterator<String>, SmartIterator<String>, SmartIterator.Detachable<String>, StringSplitter.Iterator

Enclosing interface:

StringSplitter.Async

public static interface StringSplitter.Async.Iterator
extends StringSplitter.Iterator

Iterator that splits elements lazily on demand during traversal.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface dev.sympho.modular_commands.utils.SmartIterator

SmartIterator.Detachable<E extends @NonNull Object>, SmartIterator.ListIterator<E extends @NonNull Object>, SmartIterator.Wrapper<E extends @NonNull Object>

Field Summary

Fields inherited from interface dev.sympho.modular_commands.utils.SmartIterator

NO_MORE_ELEMENTS_ERROR

Method Summary

Modifier and Type	Method	Description
String	remainder()	Retrieves the remainder of the string that has not been parsed yet.
StringSplitter.Async	splitter()	Retrieves the splitter that created this iterator.
StringSplitter.Async.Iterator	toIterator()	Returns an iterator that iterates over the remaining elements to be traversed by this iterator.

Methods inherited from interface java.util.Iterator

forEachRemaining, next, remove

Methods inherited from interface dev.sympho.modular_commands.utils.SmartIterator

hasNext, peek

Methods inherited from interface dev.sympho.modular_commands.utils.SmartIterator.Detachable

toFlux, toSpliterator, toStream

Method Details

remainder

@Pure
String remainder()

Retrieves the remainder of the string that has not been parsed yet.

Returns:

The remainder (not traversed) portion of the string.

splitter

StringSplitter.Async splitter()

Description copied from interface: StringSplitter.Iterator

Retrieves the splitter that created this iterator.

Specified by:

splitter in interface StringSplitter.Iterator

Returns:

The source splitter.

toIterator

StringSplitter.Async.Iterator toIterator()

Description copied from interface: SmartIterator.Detachable

Returns an iterator that iterates over the remaining elements to be traversed by this iterator.

The returned iterator is guaranteed to be detached from this iterator. In other words, they are completely independent of each other and may both be used separately.

Specified by:

toIterator in interface SmartIterator.Detachable<String>

Specified by:

toIterator in interface StringSplitter.Iterator

Returns:

The iterator.