org.apache.commons.collections4.list

Class AbstractListDecorator<E>

java.lang.Object

org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>

org.apache.commons.collections4.list.AbstractListDecorator<E>

Type Parameters:

E - the type of the elements in the list

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>

Direct Known Subclasses:

AbstractSerializableListDecorator

public abstract class AbstractListDecorator<E>
extends AbstractCollectionDecorator<E>
implements java.util.List<E>

Decorates another List to provide additional behaviour.

Methods are forwarded directly to the decorated list.

Since:

3.0

Version:

$Id: AbstractListDecorator.java 1477772 2013-04-30 18:44:21Z tn $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID Serialization version--necessary in an abstract class?

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractListDecorator() Constructor only used in deserialization, do not use otherwise.
protected	AbstractListDecorator(java.util.List<E> list) Constructor that wraps (not copies).

Method Summary

Modifier and Type	Method and Description
void	add(int index, E object)
boolean	addAll(int index, java.util.Collection<? extends E> coll)
protected java.util.List<E>	decorated() Gets the list being decorated.
E	get(int index)
int	indexOf(java.lang.Object object)
int	lastIndexOf(java.lang.Object object)
java.util.ListIterator<E>	listIterator()
java.util.ListIterator<E>	listIterator(int index)
E	remove(int index)
E	set(int index, E object)
java.util.List<E>	subList(int fromIndex, int toIndex)

Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, setCollection, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, replaceAll, retainAll, size, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

serialVersionUID

private static final long serialVersionUID

Serialization version--necessary in an abstract class?

See Also:

Constant Field Values

Constructor Detail

AbstractListDecorator

protected AbstractListDecorator()

Constructor only used in deserialization, do not use otherwise.

Since:

3.1

AbstractListDecorator

protected AbstractListDecorator(java.util.List<E> list)

Constructor that wraps (not copies).

Parameters:

list - the list to decorate, must not be null

Throws:

java.lang.IllegalArgumentException - if list is null

Method Detail

decorated

protected java.util.List<E> decorated()

Gets the list being decorated.

Overrides:

decorated in class AbstractCollectionDecorator<E>

Returns:

the decorated list

add

public void add(int index,
                E object)

Specified by:

add in interface java.util.List<E>

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends E> coll)

Specified by:

addAll in interface java.util.List<E>

get

public E get(int index)

Specified by:

get in interface java.util.List<E>

indexOf

public int indexOf(java.lang.Object object)

Specified by:

indexOf in interface java.util.List<E>

lastIndexOf

public int lastIndexOf(java.lang.Object object)

Specified by:

lastIndexOf in interface java.util.List<E>

listIterator

public java.util.ListIterator<E> listIterator()

Specified by:

listIterator in interface java.util.List<E>

listIterator

public java.util.ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface java.util.List<E>

remove

public E remove(int index)

Specified by:

remove in interface java.util.List<E>

set

public E set(int index,
             E object)

Specified by:

set in interface java.util.List<E>

subList

public java.util.List<E> subList(int fromIndex,
                                 int toIndex)

Specified by:

subList in interface java.util.List<E>