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

Modifier and Type	Field and Description
private boolean	beforeFirst
private boolean	nextCalled
private E	object
private boolean	removed

Access	Constructor and Description
public	SingletonListIterator(final E the single object to return from the iterator object) Constructs a new `SingletonListIterator`.

Method Summary

Modifier and Type	Method and Description
public void	add(final E the object to add obj) Implements java.util.ListIterator.add. Add always throws `UnsupportedOperationException`.
public boolean	Returns: true if the single object hasn't been returned yet hasNext() Implements java.util.ListIterator.hasNext, java.util.Iterator.hasNext. Is another object available from the iterator?
public boolean	Returns: true if the single object has been returned hasPrevious() Implements java.util.ListIterator.hasPrevious, org.apache.commons.collections4.OrderedIterator.hasPrevious. Is a previous object available from the iterator?
public E	Returns: the single object next() Implements java.util.ListIterator.next, java.util.Iterator.next. Get the next object from the iterator.
public int	Returns: 0 or 1 depending on current state. nextIndex() Implements java.util.ListIterator.nextIndex. Returns the index of the element that would be returned by a subsequent call to `next`.
public E	Returns: the single object previous() Implements java.util.ListIterator.previous, org.apache.commons.collections4.OrderedIterator.previous. Get the previous object from the iterator.
public int	Returns: 0 or -1 depending on current state. previousIndex() Implements java.util.ListIterator.previousIndex. Returns the index of the element that would be returned by a subsequent call to `previous`.
public void	remove() Overrides default java.util.Iterator.remove. Implements java.util.ListIterator.remove. Remove the object from this iterator.
public void	reset() Implements org.apache.commons.collections4.ResettableIterator.reset. Reset the iterator back to the start.
public void	set(final E the object to set obj) Implements java.util.ListIterator.set. Set sets the value of the singleton.

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

beforeFirst	back to summary
private boolean beforeFirst

nextCalled	back to summary
private boolean nextCalled

object	back to summary
private E object

removed	back to summary
private boolean removed

SingletonListIterator	back to summary
public SingletonListIterator(final E object) Constructs a new `SingletonListIterator`. Parameters object:E the single object to return from the iterator

Method Detail

add back to summary

add	back to summary
public void add(final E obj) Implements java.util.ListIterator.add. Add always throws `UnsupportedOperationException`. Parameters obj:E the object to add Annotations @Override Exceptions UnsupportedOperationException: always

public void add(final E obj)

Implements java.util.ListIterator.add.

Add always throws UnsupportedOperationException.

Parameters

obj:E: the object to add

Annotations

@Override

Exceptions

UnsupportedOperationException:: always

hasNext	back to summary
public boolean hasNext() Implements java.util.ListIterator.hasNext, 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.ListIterator.hasNext, 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

hasPrevious	back to summary
public boolean hasPrevious() Implements java.util.ListIterator.hasPrevious, org.apache.commons.collections4.OrderedIterator.hasPrevious. Is a previous object available from the iterator? This returns true if the single object has been returned. Returns:boolean true if the single object has been returned Annotations @Override

hasPrevious

back to summary

public boolean hasPrevious()

Implements java.util.ListIterator.hasPrevious, org.apache.commons.collections4.OrderedIterator.hasPrevious.

Is a previous object available from the iterator?

This returns true if the single object has been returned.

Returns:boolean

true if the single object has been returned

Annotations

@Override

next	back to summary
public E next() Implements java.util.ListIterator.next, 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.ListIterator.next, 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

nextIndex back to summary

nextIndex	back to summary
public int nextIndex() Implements java.util.ListIterator.nextIndex. Returns the index of the element that would be returned by a subsequent call to `next`. Returns:int 0 or 1 depending on current state. Annotations @Override

public int nextIndex()

Implements java.util.ListIterator.nextIndex.

Returns the index of the element that would be returned by a subsequent call to next.

Returns:int

0 or 1 depending on current state.

Annotations

@Override

previous	back to summary
public E previous() Implements java.util.ListIterator.previous, org.apache.commons.collections4.OrderedIterator.previous. Get the previous object from the iterator. This returns the single object if it has been returned. Returns:E the single object Annotations @Override Exceptions NoSuchElementException: if the single object has not already been returned

back to summary

public E previous()

Implements java.util.ListIterator.previous, org.apache.commons.collections4.OrderedIterator.previous.

Get the previous object from the iterator.

This returns the single object if it has been returned.

Returns:E

the single object

Annotations

@Override

Exceptions

NoSuchElementException:: if the single object has not already been returned

previousIndex back to summary

previousIndex	back to summary
public int previousIndex() Implements java.util.ListIterator.previousIndex. Returns the index of the element that would be returned by a subsequent call to `previous`. A return value of -1 indicates that the iterator is currently at the start. Returns:int 0 or -1 depending on current state. Annotations @Override

public int previousIndex()

Implements java.util.ListIterator.previousIndex.

Returns the index of the element that would be returned by a subsequent call to previous. A return value of -1 indicates that the iterator is currently at the start.

Returns:int

0 or -1 depending on current state.

Annotations

@Override

remove back to summary

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

public void remove()

Overrides default java.util.Iterator.remove.

Implements java.util.ListIterator.remove.

Remove the object from this iterator.

Annotations

@Override

Exceptions

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

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

reset

back to summary

public void reset()

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

Reset the iterator back to the start.

Annotations

@Override

set back to summary

set	back to summary
public void set(final E obj) Implements java.util.ListIterator.set. Set sets the value of the singleton. Parameters obj:E the object to set Annotations @Override Exceptions IllegalStateException: if `next` has not been called or the object has been removed

public void set(final E obj)

Implements java.util.ListIterator.set.

Set sets the value of the singleton.

Parameters

obj:E: the object to set

Annotations

@Override

Exceptions

IllegalStateException:: if next has not been called or the object has been removed

public Class SingletonListIterator<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail