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

Modifier and Type	Field and Description
private ListIterator<E>	iterator The current list iterator
private final List<E>	list The list to base the iterator on

Access	Constructor and Description
public	LoopingListIterator(final List<E> the list to wrap list) Constructor that wraps a list.

Method Summary

Modifier and Type	Method and Description
private void	_reset()
public void	add(final E the element to insert obj) Implements java.util.ListIterator.add. Inserts the specified element into the underlying list.
public boolean	Returns: `true` if there are more elements hasNext() Implements java.util.ListIterator.hasNext, java.util.Iterator.hasNext. Returns whether this iterator has any more elements.
public boolean	Returns: `true` if there are more elements hasPrevious() Implements java.util.ListIterator.hasPrevious, org.apache.commons.collections4.OrderedIterator.hasPrevious. Returns whether this iterator has any more previous elements.
public E	Returns: the object after the last element returned next() Implements java.util.ListIterator.next, java.util.Iterator.next. Returns the next object in the list.
public int	Returns: the index of the element that would be returned if next() were called 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 object before the last element returned previous() Implements java.util.ListIterator.previous, org.apache.commons.collections4.OrderedIterator.previous. Returns the previous object in the list.
public int	Returns: the index of the element that would be returned if previous() were called 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. Removes the previously retrieved item from the underlying list.
public void	reset() Implements org.apache.commons.collections4.ResettableIterator.reset. Resets the iterator back to the start of the list.
public void	set(final E the element with which to replace the last element returned obj) Implements java.util.ListIterator.set. Replaces the last element that was returned by `next` or `previous`.
public int	Returns: the current list size size() Gets the size of the list underlying the iterator.

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

iterator	back to summary
private ListIterator<E> iterator The current list iterator

list	back to summary
private final List<E> list The list to base the iterator on

LoopingListIterator	back to summary
public LoopingListIterator(final List<E> list) Constructor that wraps a list. There is no way to reset a ListIterator instance without recreating it from the original source, so the List must be passed in and a reference to it held. Parameters list:List<E> the list to wrap Exceptions NullPointerException: if the list it null

Method Detail

_reset	back to summary
private void _reset()

add back to summary

add	back to summary
public void add(final E obj) Implements java.util.ListIterator.add. Inserts the specified element into the underlying list. The element is inserted before the next element that would be returned by `next`, if any, and after the next element that would be returned by `previous`, if any. This feature is only supported if the underlying list's `List#listIterator` method returns an implementation that supports it. Parameters obj:E the element to insert Annotations @Override Exceptions UnsupportedOperationException: if the add method is not supported by the iterator implementation of the underlying list

public void add(final E obj)

Implements java.util.ListIterator.add.

Inserts the specified element into the underlying list.

The element is inserted before the next element that would be returned by next, if any, and after the next element that would be returned by previous, if any.

This feature is only supported if the underlying list's List#listIterator method returns an implementation that supports it.

Parameters

obj:E: the element to insert

Annotations

@Override

Exceptions

UnsupportedOperationException:: if the add method is not supported by the iterator implementation of the underlying list

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.ListIterator.hasNext, java.util.Iterator.hasNext. Returns whether this iterator has any more elements. Returns false only if the list originally had zero elements, or all elements have been `removed`. Returns:boolean `true` if there are more elements Annotations @Override

public boolean hasNext()

Implements java.util.ListIterator.hasNext, java.util.Iterator.hasNext.

Returns whether this iterator has any more elements.

Returns false only if the list originally had zero elements, or all elements have been removed.

Returns:boolean

true if there are more elements

Annotations

@Override

hasPrevious back to summary

hasPrevious	back to summary
public boolean hasPrevious() Implements java.util.ListIterator.hasPrevious, org.apache.commons.collections4.OrderedIterator.hasPrevious. Returns whether this iterator has any more previous elements. Returns false only if the list originally had zero elements, or all elements have been `removed`. Returns:boolean `true` if there are more elements Annotations @Override

public boolean hasPrevious()

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

Returns whether this iterator has any more previous elements.

Returns false only if the list originally had zero elements, or all elements have been removed.

Returns:boolean

true if there are more elements

Annotations

@Override

next	back to summary
public E next() Implements java.util.ListIterator.next, java.util.Iterator.next. Returns the next object in the list. If at the end of the list, returns the first element. Returns:E the object after the last element returned Annotations @Override Exceptions NoSuchElementException: if there are no elements in the list

back to summary

public E next()

Implements java.util.ListIterator.next, java.util.Iterator.next.

Returns the next object in the list.

If at the end of the list, returns the first element.

Returns:E

the object after the last element returned

Annotations

@Override

Exceptions

NoSuchElementException:: if there are no elements in the list

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`. As would be expected, if the iterator is at the physical end of the underlying list, 0 is returned, signifying the beginning of the list. Returns:int the index of the element that would be returned if next() were called Annotations @Override Exceptions NoSuchElementException: if there are no elements in the list

public int nextIndex()

Implements java.util.ListIterator.nextIndex.

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

As would be expected, if the iterator is at the physical end of the underlying list, 0 is returned, signifying the beginning of the list.

Returns:int

the index of the element that would be returned if next() were called

Annotations

@Override

Exceptions

NoSuchElementException:: if there are no elements in the list

previous	back to summary
public E previous() Implements java.util.ListIterator.previous, org.apache.commons.collections4.OrderedIterator.previous. Returns the previous object in the list. If at the beginning of the list, return the last element. Note that in this case, traversal to find that element takes linear time. Returns:E the object before the last element returned Annotations @Override Exceptions NoSuchElementException: if there are no elements in the list

back to summary

public E previous()

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

Returns the previous object in the list.

If at the beginning of the list, return the last element. Note that in this case, traversal to find that element takes linear time.

Returns:E

the object before the last element returned

Annotations

@Override

Exceptions

NoSuchElementException:: if there are no elements in the list

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`. As would be expected, if at the iterator is at the physical beginning of the underlying list, the list's size minus one is returned, signifying the end of the list. Returns:int the index of the element that would be returned if previous() were called Annotations @Override Exceptions NoSuchElementException: if there are no elements in the list

public int previousIndex()

Implements java.util.ListIterator.previousIndex.

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

As would be expected, if at the iterator is at the physical beginning of the underlying list, the list's size minus one is returned, signifying the end of the list.

Returns:int

the index of the element that would be returned if previous() were called

Annotations

@Override

Exceptions

NoSuchElementException:: if there are no elements in the list

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Implements java.util.ListIterator.remove. Removes the previously retrieved item from the underlying list. This feature is only supported if the underlying list's `iterator` method returns an implementation that supports it. This method can only be called after at least one `next` or `previous` method call. After a removal, the remove method may not be called again until another `next` or `previous` has been performed. If the `reset` is called, then remove may not be called until `next` or `previous` is called again. Annotations @Override Exceptions UnsupportedOperationException: if the remove method is not supported by the iterator implementation of the underlying list

public void remove()

Overrides default java.util.Iterator.remove.

Implements java.util.ListIterator.remove.

Removes the previously retrieved item from the underlying list.

This feature is only supported if the underlying list's iterator method returns an implementation that supports it.

This method can only be called after at least one next or previous method call. After a removal, the remove method may not be called again until another next or previous has been performed. If the reset is called, then remove may not be called until next or previous is called again.

Annotations

@Override

Exceptions

UnsupportedOperationException:: if the remove method is not supported by the iterator implementation of the underlying list

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

reset

back to summary

public void reset()

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

Resets the iterator back to the start of the list.

Annotations

@Override

set back to summary

set	back to summary
public void set(final E obj) Implements java.util.ListIterator.set. Replaces the last element that was returned by `next` or `previous`. This feature is only supported if the underlying list's `List#listIterator` method returns an implementation that supports it. Parameters obj:E the element with which to replace the last element returned Annotations @Override Exceptions UnsupportedOperationException: if the set method is not supported by the iterator implementation of the underlying list

public void set(final E obj)

Implements java.util.ListIterator.set.

Replaces the last element that was returned by next or previous.

This feature is only supported if the underlying list's List#listIterator method returns an implementation that supports it.

Parameters

obj:E: the element with which to replace the last element returned

Annotations

@Override

Exceptions

UnsupportedOperationException:: if the set method is not supported by the iterator implementation of the underlying list

size	back to summary
public int size() Gets the size of the list underlying the iterator. Returns:int the current list size

size

back to summary

public int size()

Gets the size of the list underlying the iterator.

Returns:int: the current list size

public Class LoopingListIterator<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail