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

java.lang.Object
  org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>
      org.apache.commons.collections4.collection.PredicatedCollection<E>
          org.apache.commons.collections4.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:

3.0

Version:

$Id: PredicatedList.java 1479405 2013-05-05 21:58:52Z tn $

See Also:

Serialized Form

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

predicatedList

public static <T> PredicatedList<T> predicatedList(List<T> list,
                                                   Predicate<? super T> predicate)

Factory method to create a predicated (validating) list.

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

Type Parameters:

T - the type of the elements in the list

Parameters:

list - the list to decorate, must not be null

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

Returns:

a new predicated list

Throws:

IllegalArgumentException - if list or predicate is null

IllegalArgumentException - if the list contains invalid elements

Since:

4.0

decorated

protected List<E> decorated()

Gets the list being decorated.

Overrides:

decorated in class AbstractCollectionDecorator<E>

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>