Package dev.sympho.modular_commands.utils

Class SmartIterator.ListIterator<E extends @NonNull Object>

java.lang.Object

dev.sympho.modular_commands.utils.SmartIterator.Wrapper<E>

dev.sympho.modular_commands.utils.SmartIterator.ListIterator<E>

Type Parameters:

E - The element type.

All Implemented Interfaces:

SmartIterator<E>, SmartIterator.Detachable<E>, Iterator<E>

Enclosing interface:

SmartIterator<E extends @NonNull Object>

public static class SmartIterator.ListIterator<E extends @NonNull Object>
extends SmartIterator.Wrapper<E>
implements SmartIterator.Detachable<E>

A smart iterator that iterates over a list.

This class relies on SmartIterator.Wrapper with an iterator provided by the list for most of its operations, and thus has the same caveats; it only has changes necessary for supporting the SmartIterator.Detachable interface.

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

Constructor Summary

Constructors

Constructor	Description
ListIterator(List<E> list)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
E	next()
protected List<E>	remaining()	Returns a list view over the portion of the list that has not been iterated over yet.
Flux<E>	toFlux()	Returns a flux that issues the remaining elements to be traversed by this iterator.
SmartIterator.Detachable<E>	toIterator()	Returns an iterator that iterates over the remaining elements to be traversed by this iterator.
Spliterator<E>	toSpliterator()	Returns a spliterator that iterates over the remaining elements to be traversed by this iterator.
Stream<E>	toStream()	Returns a stream that contains over the remaining elements to be traversed by this iterator.

Methods inherited from class dev.sympho.modular_commands.utils.SmartIterator.Wrapper

peek

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, remove

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

hasNext, peek

Constructor Details

ListIterator

public ListIterator(List<E> list)

Creates a new instance.

Parameters:

list - The list to iterate over.

Method Details

remaining

@SideEffectFree
protected List<E> remaining()

Returns a list view over the portion of the list that has not been iterated over yet.

Returns:

The remaining items as a list.

next

public E next()
       throws NoSuchElementException

Specified by:

next in interface Iterator<E extends @NonNull Object>

Overrides:

next in class SmartIterator.Wrapper<E extends @NonNull Object>

Throws:

NoSuchElementException

toIterator

public SmartIterator.Detachable<E> 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<E extends @NonNull Object>

Returns:

The iterator.

toSpliterator

public Spliterator<E> toSpliterator()

Description copied from interface: SmartIterator.Detachable

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

The returned spliterator 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:

toSpliterator in interface SmartIterator<E extends @NonNull Object>

Specified by:

toSpliterator in interface SmartIterator.Detachable<E extends @NonNull Object>

Returns:

The spliterator.

toStream

public Stream<E> toStream()

Description copied from interface: SmartIterator.Detachable

Returns a stream that contains over the remaining elements to be traversed by this iterator.

The returned stream 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:

toStream in interface SmartIterator<E extends @NonNull Object>

Specified by:

toStream in interface SmartIterator.Detachable<E extends @NonNull Object>

Returns:

The stream.

toFlux

public Flux<E> toFlux()

Description copied from interface: SmartIterator.Detachable

Returns a flux that issues the remaining elements to be traversed by this iterator.

The returned flux 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:

toFlux in interface SmartIterator<E extends @NonNull Object>

Specified by:

toFlux in interface SmartIterator.Detachable<E extends @NonNull Object>

Returns:

The flux.