org.apache.commons.collections.list
Class AbstractListDecorator

java.lang.Object
  org.apache.commons.collections.collection.AbstractCollectionDecorator
      org.apache.commons.collections.list.AbstractListDecorator

All Implemented Interfaces:

java.lang.Iterable, java.util.Collection, java.util.List

Direct Known Subclasses:

AbstractSerializableListDecorator

public abstract class AbstractListDecorator
extends AbstractCollectionDecorator
implements java.util.List

Decorates another List to provide additional behaviour.

Methods are forwarded directly to the decorated list.

Since:

Commons Collections 3.0

Version:

$Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $

Author:

Stephen Colebourne

Field Summary

Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator

collection

Constructor Summary

protected	AbstractListDecorator() Constructor only used in deserialization, do not use otherwise.
protected	AbstractListDecorator(java.util.List list) Constructor that wraps (not copies).

Method Summary

void	add(int index, java.lang.Object object)
boolean	addAll(int index, java.util.Collection coll)
java.lang.Object	get(int index)
protected java.util.List	getList() Gets the list being decorated.
int	indexOf(java.lang.Object object)
int	lastIndexOf(java.lang.Object object)
java.util.ListIterator	listIterator()
java.util.ListIterator	listIterator(int index)
java.lang.Object	remove(int index)
java.lang.Object	set(int index, java.lang.Object object)
java.util.List	subList(int fromIndex, int toIndex)

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

add, addAll, clear, contains, containsAll, equals, getCollection, hashCode, isEmpty, iterator, remove, removeAll, retainAll, 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, retainAll, size, toArray, toArray

Constructor Detail

AbstractListDecorator

protected AbstractListDecorator()

Constructor only used in deserialization, do not use otherwise.

Since:

Commons Collections 3.1

AbstractListDecorator

protected AbstractListDecorator(java.util.List 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

getList

protected java.util.List getList()

Gets the list being decorated.

Returns:

the decorated list

add

public void add(int index,
                java.lang.Object object)

Specified by:

add in interface java.util.List

addAll

public boolean addAll(int index,
                      java.util.Collection coll)

Specified by:

addAll in interface java.util.List

get

public java.lang.Object get(int index)

Specified by:

get in interface java.util.List

indexOf

public int indexOf(java.lang.Object object)

Specified by:

indexOf in interface java.util.List

lastIndexOf

public int lastIndexOf(java.lang.Object object)

Specified by:

lastIndexOf in interface java.util.List

listIterator

public java.util.ListIterator listIterator()

Specified by:

listIterator in interface java.util.List

listIterator

public java.util.ListIterator listIterator(int index)

Specified by:

listIterator in interface java.util.List

remove

public java.lang.Object remove(int index)

Specified by:

remove in interface java.util.List

set

public java.lang.Object set(int index,
                            java.lang.Object object)

Specified by:

set in interface java.util.List

subList

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

Specified by:

subList in interface java.util.List