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

Field Summary

Modifier and Type	Field and Description
private boolean	beforeFirst Is the cursor before the first element
private E	object The object
private final boolean	removeAllowed Whether remove is allowed
private boolean	removed Has the element been removed

Constructor Summary

Access	Constructor and Description
public	SingletonIterator(final E the single object to return from the iterator object) Constructs a new `SingletonIterator` where `remove` is a permitted operation.
public	SingletonIterator(final E the single object to return from the iterator object, final boolean true if remove is allowed removeAllowed) Constructs a new `SingletonIterator` optionally choosing if `remove` is a permitted operation.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if the single object hasn't been returned yet hasNext() Implements java.util.Iterator.hasNext. Is another object available from the iterator?
public E	Returns: the single object next() Implements java.util.Iterator.next. Get the next object from the iterator.
public void	remove() Overrides default java.util.Iterator.remove. Remove the object from this iterator.
public void	reset() Implements org.apache.commons.collections4.ResettableIterator.reset. Reset the iterator to the start.

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

Field Detail

beforeFirst	back to summary
private boolean beforeFirst Is the cursor before the first element

object	back to summary
private E object The object

removeAllowed	back to summary
private final boolean removeAllowed Whether remove is allowed

removed	back to summary
private boolean removed Has the element been removed

Constructor Detail

SingletonIterator back to summary

SingletonIterator	back to summary
public SingletonIterator(final E object) Constructs a new `SingletonIterator` where `remove` is a permitted operation. Parameters object:E the single object to return from the iterator

public SingletonIterator(final E object)

Constructs a new SingletonIterator where remove is a permitted operation.

Parameters

object:E: the single object to return from the iterator

SingletonIterator back to summary

SingletonIterator	back to summary
public SingletonIterator(final E object, final boolean removeAllowed) Constructs a new `SingletonIterator` optionally choosing if `remove` is a permitted operation. Parameters object:E the single object to return from the iterator removeAllowed:boolean true if remove is allowed Since 3.1

public SingletonIterator(final E object, final boolean removeAllowed)

Constructs a new SingletonIterator optionally choosing if remove is a permitted operation.

Parameters

object:E: the single object to return from the iterator
removeAllowed:boolean: true if remove is allowed

Since

3.1

Method Detail

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Is another object available from the iterator? This returns true if the single object hasn't been returned yet. Returns:boolean true if the single object hasn't been returned yet Annotations @Override

hasNext

back to summary

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Is another object available from the iterator?

This returns true if the single object hasn't been returned yet.

Returns:boolean

true if the single object hasn't been returned yet

Annotations

@Override

next	back to summary
public E next() Implements java.util.Iterator.next. Get the next object from the iterator. This returns the single object if it hasn't been returned yet. Returns:E the single object Annotations @Override Exceptions NoSuchElementException: if the single object has already been returned

back to summary

public E next()

Implements java.util.Iterator.next.

Get the next object from the iterator.

This returns the single object if it hasn't been returned yet.

Returns:E

the single object

Annotations

@Override

Exceptions

NoSuchElementException:: if the single object has already been returned

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Remove the object from this iterator. Annotations @Override Exceptions IllegalStateException: if the `next` method has not yet been called, or the `remove` method has already been called after the last call to the `next` method. UnsupportedOperationException: if remove is not supported

public void remove()

Overrides default java.util.Iterator.remove.

Remove the object from this iterator.

Annotations

@Override

Exceptions

IllegalStateException:: if the next method has not yet been called, or the remove method has already been called after the last call to the next method.
UnsupportedOperationException:: if remove is not supported

reset	back to summary
public void reset() Implements org.apache.commons.collections4.ResettableIterator.reset. Reset the iterator to the start. Annotations @Override

reset

back to summary

public void reset()

Implements org.apache.commons.collections4.ResettableIterator.reset.

Reset the iterator to the start.

Annotations

@Override

public Class SingletonIterator<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail