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 anotherList
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<String> list = PredicatedList.predicatedList(new ArrayList<String>(), PredicateUtils.notNullPredicate());
This class is Serializable from Commons Collections 3.1.
- Since:
- 3.0
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
PredicatedList.PredicatedListIterator
Inner class Iterator for the PredicatedList-
Nested classes/interfaces inherited from class org.apache.commons.collections4.collection.PredicatedCollection
PredicatedCollection.Builder<E>
-
-
Field Summary
-
Fields inherited from class org.apache.commons.collections4.collection.PredicatedCollection
predicate
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
PredicatedList(java.util.List<E> list, Predicate<? super E> predicate)
Constructor that wraps (not copies).
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.boolean
equals(java.lang.Object object)
E
get(int index)
int
hashCode()
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, builder, notNullBuilder, predicatedCollection, validate
-
Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator
clear, contains, containsAll, isEmpty, iterator, remove, removeAll, removeIf, retainAll, setCollection, size, toArray, toArray, toString
-
-
-
-
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 nullpredicate
- the predicate to use for validation, must not be null- Throws:
java.lang.NullPointerException
- if list or predicate is nulljava.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 nullpredicate
- the predicate to use for validation, must not be null- Returns:
- a new predicated list
- Throws:
java.lang.NullPointerException
- if list or predicate is nulljava.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 classAbstractCollectionDecorator<E>
- Returns:
- the decorated list
-
equals
public boolean equals(java.lang.Object object)
-
hashCode
public int hashCode()
-
indexOf
public int indexOf(java.lang.Object object)
- Specified by:
indexOf
in interfacejava.util.List<E>
-
lastIndexOf
public int lastIndexOf(java.lang.Object object)
- Specified by:
lastIndexOf
in interfacejava.util.List<E>
-
addAll
public boolean addAll(int index, java.util.Collection<? extends E> coll)
- Specified by:
addAll
in interfacejava.util.List<E>
-
listIterator
public java.util.ListIterator<E> listIterator()
- Specified by:
listIterator
in interfacejava.util.List<E>
-
listIterator
public java.util.ListIterator<E> listIterator(int i)
- Specified by:
listIterator
in interfacejava.util.List<E>
-
-