org.apache.commons.collections4.iterators

Class AbstractListIteratorDecorator<E>

java.lang.Object

org.apache.commons.collections4.iterators.AbstractListIteratorDecorator<E>

All Implemented Interfaces:

java.util.Iterator<E>, java.util.ListIterator<E>

Direct Known Subclasses:

FixedSizeList.FixedSizeListIterator, PredicatedList.PredicatedListIterator, SetUniqueList.SetListListIterator, TransformedList.TransformedListIterator

public class AbstractListIteratorDecorator<E>
extends java.lang.Object
implements java.util.ListIterator<E>

Provides basic behaviour for decorating a list iterator with extra functionality.

All methods are forwarded to the decorated list iterator.

Since:

3.0

Version:

$Id: AbstractListIteratorDecorator.java 1477802 2013-04-30 20:01:28Z tn $

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.ListIterator<E>	iterator The iterator being decorated

Constructor Summary

Constructors

Constructor and Description
AbstractListIteratorDecorator(java.util.ListIterator<E> iterator) Constructor that decorates the specified iterator.

Method Summary

Modifier and Type	Method and Description
void	add(E obj)
protected java.util.ListIterator<E>	getListIterator() Gets the iterator being decorated.
boolean	hasNext()
boolean	hasPrevious()
E	next()
int	nextIndex()
E	previous()
int	previousIndex()
void	remove()
void	set(E obj)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

iterator

private final java.util.ListIterator<E> iterator

The iterator being decorated

Constructor Detail

AbstractListIteratorDecorator

public AbstractListIteratorDecorator(java.util.ListIterator<E> iterator)

Constructor that decorates the specified iterator.

Parameters:

iterator - the iterator to decorate, must not be null

Throws:

java.lang.IllegalArgumentException - if the collection is null

Method Detail

getListIterator

protected java.util.ListIterator<E> getListIterator()

Gets the iterator being decorated.

Returns:

the decorated iterator

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<E>

Specified by:

hasNext in interface java.util.ListIterator<E>

next

public E next()

Specified by:

next in interface java.util.Iterator<E>

Specified by:

next in interface java.util.ListIterator<E>

nextIndex

public int nextIndex()

Specified by:

nextIndex in interface java.util.ListIterator<E>

hasPrevious

public boolean hasPrevious()

Specified by:

hasPrevious in interface java.util.ListIterator<E>

previous

public E previous()

Specified by:

previous in interface java.util.ListIterator<E>

previousIndex

public int previousIndex()

Specified by:

previousIndex in interface java.util.ListIterator<E>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<E>

Specified by:

remove in interface java.util.ListIterator<E>

set

public void set(E obj)

Specified by:

set in interface java.util.ListIterator<E>

add

public void add(E obj)

Specified by:

add in interface java.util.ListIterator<E>