net.digitalid.utility.collections.iterator

Class FreezableIterator<E>

java.lang.Object

net.digitalid.utility.collections.iterator.FreezableIterator<E>

All Implemented Interfaces:

Iterator<E>

@Mutable
 @GenerateSubclass
public abstract class FreezableIterator<E>
extends Object
implements Iterator<E>

This class models an iterator which is backed by a freezable collection.

Constructor Summary

Constructors

Constructor and Description
FreezableIterator()

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
E	next()
void	remove()
static <E> @Nonnull FreezableIterator<E>	with(@Nonnull Iterator<E> iterator, @Nonnull FreezableCollection<E> collection) Returns a new freezable iterator backed by the given iterator and freezable collection.

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

FreezableIterator

public FreezableIterator()

Method Detail

with

@Pure
 @Nonnull
public static <E> @Nonnull FreezableIterator<E> with(@Captured @Nonnull
                                                                     @Nonnull Iterator<E> iterator,
                                                                     @Shared @Nonnull
                                                                     @Nonnull FreezableCollection<E> collection)

Returns a new freezable iterator backed by the given iterator and freezable collection.

hasNext

@Pure
public boolean hasNext()

Specified by:

hasNext in interface Iterator<E>

next

@Impure
public E next()
               throws NoSuchElementException

Specified by:

next in interface Iterator<E>

Throws:

NoSuchElementException

remove

@Impure
public void remove()
                    throws IllegalStateException

Specified by:

remove in interface Iterator<E>

Throws:

IllegalStateException