org.apache.commons.collections.list
Class PredicatedList<E>

java.lang.Object
  org.apache.commons.collections.collection.AbstractCollectionDecorator<E>
      org.apache.commons.collections.collection.AbstractSerializableCollectionDecorator<E>
          org.apache.commons.collections.collection.PredicatedCollection<E>
              org.apache.commons.collections.list.PredicatedList<E>

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, List<E>

public class PredicatedList<E>
extends PredicatedCollection<E>
implements List<E>

Decorates another List to validate that all additions match a specified predicate.

This list exists to provide validation for the decorated list. It is normally created to decorate an empty list. If an object cannot be added to the list, an IllegalArgumentException is thrown.

One usage would be to ensure that no null entries are added to the list.

List list = PredicatedList.decorate(new ArrayList(), NotNullPredicate.INSTANCE);

This class is Serializable from Commons Collections 3.1.

Since:

Commons Collections 3.0

Version:

$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:35:24 $

Author:

Matt Hall, John Watkinson, Stephen Colebourne, Paul Jack

See Also:

Serialized Form

Nested Class Summary

protected class

PredicatedList.PredicatedListIterator Inner class Iterator for the PredicatedList

Field Summary

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

predicate

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

collection

Constructor Summary

protected

PredicatedList(List<E> list, Predicate<? super E> predicate) Constructor that wraps (not copies).

Method Summary

void	add(int index, E object)
boolean	addAll(int index, Collection<? extends E> coll)
static <E> List<E>	decorate(List<E> list, Predicate<? super E> predicate) Factory method to create a predicated (validating) list.
E	get(int index)
protected List<E>	getList() Gets the list being decorated.
int	indexOf(Object object)
int	lastIndexOf(Object object)
ListIterator<E>	listIterator()
ListIterator<E>	listIterator(int i)
E	remove(int index)
E	set(int index, E object)
List<E>	subList(int fromIndex, int toIndex)

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

add, addAll, decorate, validate

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

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

PredicatedList

protected PredicatedList(List<E> list,
                         Predicate<? super E> predicate)

Constructor that wraps (not copies).

If there are any elements already in the list being decorated, they are validated.

Parameters:

list - the list to decorate, must not be null

predicate - the predicate to use for validation, must not be null

Throws:

IllegalArgumentException - if list or predicate is null

IllegalArgumentException - if the list contains invalid elements

Method Detail

decorate

public static <E> List<E> decorate(List<E> list,
                                   Predicate<? super E> predicate)

Factory method to create a predicated (validating) list.

If there are any elements already in the list being decorated, they are validated.

Parameters:

list - the list to decorate, must not be null

predicate - the predicate to use for validation, must not be null

Throws:

IllegalArgumentException - if list or predicate is null

IllegalArgumentException - if the list contains invalid elements

getList

protected List<E> getList()

Gets the list being decorated.

Returns:

the decorated list

get

public E get(int index)

Specified by:

get in interface List<E>

indexOf

public int indexOf(Object object)

Specified by:

indexOf in interface List<E>

lastIndexOf

public int lastIndexOf(Object object)

Specified by:

lastIndexOf in interface List<E>

remove

public E remove(int index)

Specified by:

remove in interface List<E>

add

public void add(int index,
                E object)

Specified by:

add in interface List<E>

addAll

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

Specified by:

addAll in interface List<E>

listIterator

public ListIterator<E> listIterator()

Specified by:

listIterator in interface List<E>

listIterator

public ListIterator<E> listIterator(int i)

Specified by:

listIterator in interface List<E>

set

public E set(int index,
             E object)

Specified by:

set in interface List<E>

subList

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

Specified by:

subList in interface List<E>