Apache Commons Collections 4.4 · org.apache.commons.collections4.iterators.EnumerationIterator

Modifier and Type	Field and Description
private final Collection<? super E>	collection The collection to remove elements from
private Enumeration<? extends E>	enumeration The enumeration being converted
private E	last The last object retrieved

Constructor Summary

Access	Constructor and Description
public	EnumerationIterator() Constructs a new `EnumerationIterator` that will not function until `setEnumeration(Enumeration)` is called.
public	EnumerationIterator(final Enumeration<? extends E> the enumeration to use enumeration) Constructs a new `EnumerationIterator` that provides an iterator view of the given enumeration.
public	EnumerationIterator(final Enumeration<? extends E> the enumeration to use enumeration, final Collection<? super E> the collection to remove elements from collection) Constructs a new `EnumerationIterator` that will remove elements from the specified collection.

Method Summary

Modifier and Type	Method and Description
public Enumeration<? extends E>	Returns: the underlying enumeration getEnumeration() Returns the underlying enumeration.
public boolean	Returns: true if the underlying enumeration has more elements hasNext() Implements java.util.Iterator.hasNext. Returns true if the underlying enumeration has more elements.
public E	Returns: the next object from the enumeration next() Implements java.util.Iterator.next. Returns the next object from the enumeration.
public void	remove() Overrides default java.util.Iterator.remove. Removes the last retrieved element if a collection is attached.
public void	setEnumeration(final Enumeration<? extends E> the new underlying enumeration enumeration) Sets the underlying enumeration.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

collection	back to summary
private final Collection<? super E> collection The collection to remove elements from

enumeration	back to summary
private Enumeration<? extends E> enumeration The enumeration being converted

last	back to summary
private E last The last object retrieved

Constructor Detail

EnumerationIterator	back to summary
public EnumerationIterator() Constructs a new `EnumerationIterator` that will not function until `setEnumeration(Enumeration)` is called.

EnumerationIterator back to summary

EnumerationIterator	back to summary
public EnumerationIterator(final Enumeration<? extends E> enumeration) Constructs a new `EnumerationIterator` that provides an iterator view of the given enumeration. Parameters enumeration:Enumeration<? extends E> the enumeration to use

public EnumerationIterator(final Enumeration<? extends E> enumeration)

Constructs a new EnumerationIterator that provides an iterator view of the given enumeration.

Parameters

enumeration:Enumeration<? extends E>: the enumeration to use

EnumerationIterator back to summary

EnumerationIterator	back to summary
public EnumerationIterator(final Enumeration<? extends E> enumeration, final Collection<? super E> collection) Constructs a new `EnumerationIterator` that will remove elements from the specified collection. Parameters enumeration:Enumeration<? extends E> the enumeration to use collection:Collection<? super E> the collection to remove elements from

public EnumerationIterator(final Enumeration<? extends E> enumeration, final Collection<? super E> collection)

Constructs a new EnumerationIterator that will remove elements from the specified collection.

Parameters

enumeration:Enumeration<? extends E>: the enumeration to use
collection:Collection<? super E>: the collection to remove elements from

Method Detail

getEnumeration	back to summary
public Enumeration<? extends E> getEnumeration() Returns the underlying enumeration. Returns:Enumeration<? extends E> the underlying enumeration

getEnumeration

back to summary

public Enumeration<? extends E> getEnumeration()

Returns the underlying enumeration.

Returns:Enumeration<? extends E>: the underlying enumeration

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Returns true if the underlying enumeration has more elements. Returns:boolean true if the underlying enumeration has more elements Annotations @Override Exceptions NullPointerException: if the underlying enumeration is null

hasNext

back to summary

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Returns true if the underlying enumeration has more elements.

Returns:boolean

true if the underlying enumeration has more elements

Annotations

@Override

Exceptions

NullPointerException:: if the underlying enumeration is null

next	back to summary
public E next() Implements java.util.Iterator.next. Returns the next object from the enumeration. Returns:E the next object from the enumeration Annotations @Override Exceptions NullPointerException: if the enumeration is null

back to summary

public E next()

Implements java.util.Iterator.next.

Returns the next object from the enumeration.

Returns:E

the next object from the enumeration

Annotations

@Override

Exceptions

NullPointerException:: if the enumeration is null

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Removes the last retrieved element if a collection is attached. Functions if an associated `Collection` is known. If so, the first occurrence of the last returned object from this iterator will be removed from the collection. Annotations @Override Exceptions IllegalStateException: `next()` not called. UnsupportedOperationException: if no associated collection

public void remove()

Overrides default java.util.Iterator.remove.

Removes the last retrieved element if a collection is attached.

Functions if an associated Collection is known. If so, the first occurrence of the last returned object from this iterator will be removed from the collection.

Annotations

@Override

Exceptions

IllegalStateException:: next() not called.
UnsupportedOperationException:: if no associated collection

setEnumeration	back to summary
public void setEnumeration(final Enumeration<? extends E> enumeration) Sets the underlying enumeration. Parameters enumeration:Enumeration<? extends E> the new underlying enumeration

setEnumeration

back to summary

public void setEnumeration(final Enumeration<? extends E> enumeration)

Sets the underlying enumeration.

Parameters

enumeration:Enumeration<? extends E>: the new underlying enumeration

public Class EnumerationIterator<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail