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:

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

public class PredicatedList<E>
extends PredicatedCollection<E>
implements java.util.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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PredicatedList.PredicatedListIterator Inner class Iterator for the PredicatedList

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID Serialization version

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

predicate

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PredicatedList(java.util.List<E> list, Predicate<? super E> predicate) 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 i)
static <T> PredicatedList<T>	predicatedList(java.util.List<T> list, Predicate<? super T> predicate) Factory method to create a predicated (validating) list.
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.PredicatedCollection

add, addAll, predicatedCollection, validate

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

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

See Also:

Constant Field Values

Constructor Detail

PredicatedList

protected PredicatedList(java.util.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:

java.lang.IllegalArgumentException - if list or predicate is null

java.lang.IllegalArgumentException - if the list contains invalid elements

Method Detail

predicatedList

public static <T> PredicatedList<T> predicatedList(java.util.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:

java.lang.IllegalArgumentException - if list or predicate is null

java.lang.IllegalArgumentException - if the list contains invalid elements

Since:

4.0

decorated

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

remove

public E remove(int index)

Specified by:

remove in interface java.util.List<E>

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>

listIterator

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

Specified by:

listIterator in interface java.util.List<E>

listIterator

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

Specified by:

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