info.bioinfweb.commons.collections

Class ListIteratorDecorator<E>

java.lang.Object

info.bioinfweb.commons.collections.ListIteratorDecorator<E>

Type Parameters:

E - the type of elements over which this instance iterates

All Implemented Interfaces:

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

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

Classes that decorate (wrap) a ListIterator can be inherited from this class.

In addition to the delegation of all methods to the underlying iterator this class provides the empty methods afterAdd(int, Object), afterReplace(int, Object, Object) and afterRemove(int, Object) that can be overwritten by inherited classes to react to modifications of the associated list made by this iterator. They are called from the according methods that make such modifications.

Since:

1.1.0

Author:

Ben Stöver

Constructor Summary

Constructors

Constructor and Description
ListIteratorDecorator(java.util.ListIterator<E> underlyingIterator) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
void	add(E e)
protected void	afterAdd(int index, E element) This method is called at the end of add(Object) to indicate that an element has been inserted.
protected void	afterRemove(int index, E element) This method is called at the end of remove() to indicate that an element has been removed from the associated list.
protected void	afterReplace(int index, E previousElement, E currentElement) This method is called at the end of set(Object) to indicate that an element has been replaced.
protected void	beforeAdd(int index, E element) This method is called at the beginning of add(Object) to indicate that an element will be inserted.
protected void	beforeRemove(int index, java.lang.Object element) This method is called at the beginning of remove() to indicate that an element will be removed from the associated list.
protected void	beforeReplace(int index, E currentElement, E newElement) This method is called at the beginning of set(Object) to indicate that an element will be replaced.
protected java.util.ListIterator<E>	getUnderlyingIterator() Returns the list iterator that has been decorated by this instance.
boolean	hasNext()
boolean	hasPrevious()
E	next()
int	nextIndex()
E	previous()
int	previousIndex()
void	remove()
void	set(E e)

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

Constructor Detail

ListIteratorDecorator

public ListIteratorDecorator(java.util.ListIterator<E> underlyingIterator)

Creates a new instance of this class.

Parameters:

underlyingIterator - the list iterator to be decorated by this instance

Method Detail

getUnderlyingIterator

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

Returns the list iterator that has been decorated by this instance.

Returns:

the underlying list iterator

beforeAdd

protected void beforeAdd(int index,
                         E element)

This method is called at the beginning of add(Object) to indicate that an element will be inserted. This default implementation is empty and can be overwritten by inherited classes which want to track modifications made by this iterator.

Parameters:

index - the index where the first new element will be inserted

element - the new element that will be inserted

afterAdd

protected void afterAdd(int index,
                        E element)

This method is called at the end of add(Object) to indicate that an element has been inserted. This default implementation is empty and can be overwritten by inherited classes which want to track modifications made by this iterator.

Parameters:

index - the index where the first new element has been inserted

element - the new element that has been inserted

beforeReplace

protected void beforeReplace(int index,
                             E currentElement,
                             E newElement)

This method is called at the beginning of set(Object) to indicate that an element will be replaced. This default implementation is empty and can be overwritten by inherited classes which want to track modifications made by this iterator.

Parameters:

index - the index where the element will be replaced

currentElement - the element that will be replaced

newElement - the new element that will replace the current element

afterReplace

protected void afterReplace(int index,
                            E previousElement,
                            E currentElement)

This method is called at the end of set(Object) to indicate that an element has been replaced. This default implementation is empty and can be overwritten by inherited classes which want to track modifications made by this iterator.

Parameters:

index - the index where the element has been replaced

previousElement - the element that has been replaced

currentElement - the new element that is now contained in the list

beforeRemove

protected void beforeRemove(int index,
                            java.lang.Object element)

This method is called at the beginning of remove() to indicate that an element will be removed from the associated list. This default implementation is empty and can be overwritten by inherited classes which want to track modifications made by this iterator.

Parameters:

index - the index of the element to be removed

element - the element that will be removed

afterRemove

protected void afterRemove(int index,
                           E element)

This method is called at the end of remove() to indicate that an element has been removed from the associated list. This default implementation is empty and can be overwritten by inherited classes which want to track modifications made by this iterator.

Parameters:

index - the index of the element that has been removed

element - the element that has been removed

add

public void add(E e)

Specified by:

add in interface java.util.ListIterator<E>

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<E>

Specified by:

hasNext in interface java.util.ListIterator<E>

hasPrevious

public boolean hasPrevious()

Specified by:

hasPrevious 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>

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 e)

Specified by:

set in interface java.util.ListIterator<E>