net.digitalid.utility.functional.iterators

Class ReadOnlyArrayIterator<ELEMENT>

java.lang.Object

net.digitalid.utility.functional.iterators.ReadOnlyIterator<ELEMENT>

net.digitalid.utility.functional.iterators.ReadOnlyArrayIterator<ELEMENT>

All Implemented Interfaces:

Iterator<ELEMENT>

@Mutable
public class ReadOnlyArrayIterator<ELEMENT>
extends ReadOnlyIterator<ELEMENT>

This class implements an array iterator that iterates over the given elements.

Field Summary

Fields

Modifier and Type	Field and Description
protected ELEMENT[]	elements

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReadOnlyArrayIterator(ELEMENT... elements)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
boolean	hasPrevious() Returns whether this iterator has a previous element.
ELEMENT	next()
@NonNegative int	nextIndex() Returns the index of the next element.
ELEMENT	previous() Returns the previous element of this iterator.
@NonNegative int	previousIndex() Returns the index of the previous element.
static <ELEMENT> @Nonnull ReadOnlyArrayIterator<ELEMENT>	with(ELEMENT... elements) Returns a new read-only array iterator that iterates over the given elements.

Methods inherited from class net.digitalid.utility.functional.iterators.ReadOnlyIterator

remove

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

Field Detail

elements

@Shared
 @Nonnull
protected final ELEMENT[] elements

Constructor Detail

ReadOnlyArrayIterator

@SafeVarargs
protected ReadOnlyArrayIterator(@Shared @Unmodified @Nonnull
                                             ELEMENT... elements)

Method Detail

with

@Pure
 @SafeVarargs
 @Capturable
 @Nonnull
public static <ELEMENT> @Nonnull ReadOnlyArrayIterator<ELEMENT> with(@Shared @Unmodified @Nonnull
                                                                                                                ELEMENT... elements)

Returns a new read-only array iterator that iterates over the given elements.

hasNext

@Pure
public boolean hasNext()

Specified by:

hasNext in interface Iterator<ELEMENT>

Specified by:

hasNext in class ReadOnlyIterator<ELEMENT>

next

@Impure
 @NonCapturable
public ELEMENT next()

Specified by:

next in interface Iterator<ELEMENT>

Specified by:

next in class ReadOnlyIterator<ELEMENT>

nextIndex

@Pure
 @NonNegative
public @NonNegative int nextIndex()

Returns the index of the next element.

Throws:

NoSuchElementException - if there is no next element.

hasPrevious

@Pure
public boolean hasPrevious()

Returns whether this iterator has a previous element.

previous

@Impure
 @NonCapturable
public ELEMENT previous()

Returns the previous element of this iterator.

previousIndex

@Pure
 @NonNegative
public @NonNegative int previousIndex()

Returns the index of the previous element.

Throws:

NoSuchElementException - if there is no previous element.