de.larssh.utils.collection

Class ProxiedIterator<E>

java.lang.Object

de.larssh.utils.collection.ProxiedIterator<E>

Type Parameters:

E - the type of elements in this iterator

All Implemented Interfaces:

Iterator<E>

Direct Known Subclasses:

ProxiedListIterator

public abstract class ProxiedIterator<E>
extends Object
implements Iterator<E>

An abstract Iterator implementation pointing to a given iterator.

Constructor Summary

Constructors

Constructor and Description
ProxiedIterator(Iterator<E> iterator) Creates a new ProxiedIterator instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
protected Iterator<E>	getProxiedForRead() Returns the wrapped iterator without verifying if modifying the underlying collection is prohibited.
protected Iterator<E>	getProxiedIfModifiable() Verifies if the underlying collection is modifiable and either returns the wrapped iterator or throws an appropriate exception.
int	hashCode()
boolean	hasNext()
boolean	isModifiable() Flag specifying if the underlying collection can be modified
E	next()
void	remove()
protected void	setModifiable(boolean modifiable) Flag specifying if the underlying collection can be modified

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

ProxiedIterator

public ProxiedIterator(Iterator<E> iterator)

Creates a new ProxiedIterator instance.

Parameters:

iterator - Wrapped iterator

Method Detail

equals

public boolean equals(@CheckForNull
                      Object object)

Overrides:

equals in class Object

getProxiedIfModifiable

protected Iterator<E> getProxiedIfModifiable()

Verifies if the underlying collection is modifiable and either returns the wrapped iterator or throws an appropriate exception.

Returns:

the wrapped iterator if the underlying collection is modifiable

Throws:

UnsupportedOperationException - if the underlying collection is unmodifiable

getProxiedForRead

protected Iterator<E> getProxiedForRead()

Returns the wrapped iterator without verifying if modifying the underlying collection is prohibited.

Returns:

the wrapped iterator

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<E>

next

@Nullable
public E next()

Specified by:

next in interface Iterator<E>

remove

public void remove()

Specified by:

remove in interface Iterator<E>

isModifiable

public boolean isModifiable()

Flag specifying if the underlying collection can be modified

Returns:

true if the underlying collection is modifiable, else false

setModifiable

protected void setModifiable(boolean modifiable)

Flag specifying if the underlying collection can be modified

Parameters:

modifiable - flag