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>
- Type Parameters:
E
- the type of the elements in the list.
- All Implemented Interfaces:
Serializable
,Iterable<E>
,Collection<E>
,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<String> list =
PredicatedList.predicatedList(new ArrayList<String>(), PredicateUtils.notNullPredicate());
This class is Serializable from Commons Collections 3.1.
- Since:
- 3.0
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected class
Inner class Iterator for the PredicatedListNested 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
ModifierConstructorDescriptionprotected
PredicatedList
(List<E> list, Predicate<? super E> predicate) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionvoid
boolean
addAll
(int index, Collection<? extends E> coll) Gets the list being decorated.boolean
get
(int index) int
hashCode()
int
int
lastIndexOf
(Object object) listIterator
(int i) static <T> PredicatedList
<T> predicatedList
(List<T> list, Predicate<? super T> predicate) Factory method to create a predicated (validating) list.remove
(int index) 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
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream
-
Constructor Details
-
PredicatedList
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:
NullPointerException
- if list or predicate is nullIllegalArgumentException
- if the list contains invalid elements
-
-
Method Details
-
predicatedList
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:
NullPointerException
- if list or predicate is nullIllegalArgumentException
- if the list contains invalid elements- Since:
- 4.0
-
add
-
addAll
-
decorated
Gets the list being decorated.- Overrides:
decorated
in classAbstractCollectionDecorator<E>
- Returns:
- the decorated list
-
equals
-
get
-
hashCode
-
indexOf
-
lastIndexOf
- Specified by:
lastIndexOf
in interfaceList<E>
-
listIterator
- Specified by:
listIterator
in interfaceList<E>
-
listIterator
- Specified by:
listIterator
in interfaceList<E>
-
remove
-
set
-
subList
-