|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.collections4.collection.AbstractCollectionDecorator<E>
org.apache.commons.collections4.collection.PredicatedCollection<E>
org.apache.commons.collections4.list.PredicatedList<E>
public class PredicatedList<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.
Nested Class Summary | |
---|---|
protected class |
PredicatedList.PredicatedListIterator
Inner class Iterator for the PredicatedList |
Field Summary |
---|
Fields inherited from class org.apache.commons.collections4.collection.PredicatedCollection |
---|
predicate |
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)
|
|
protected List<E> |
decorated()
Gets the list being decorated. |
|
E |
get(int index)
|
|
int |
indexOf(Object object)
|
|
int |
lastIndexOf(Object object)
|
|
ListIterator<E> |
listIterator()
|
|
ListIterator<E> |
listIterator(int i)
|
|
static
|
predicatedList(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)
|
|
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, retainAll, size, toArray, toArray |
Constructor Detail |
---|
protected PredicatedList(List<E> list, Predicate<? super E> predicate)
If there are any elements already in the list being decorated, they are validated.
list
- the list to decorate, must not be nullpredicate
- the predicate to use for validation, must not be null
IllegalArgumentException
- if list or predicate is null
IllegalArgumentException
- if the list contains invalid elementsMethod Detail |
---|
public static <T> PredicatedList<T> predicatedList(List<T> list, Predicate<? super T> predicate)
If there are any elements already in the list being decorated, they are validated.
T
- the type of the elements in the listlist
- the list to decorate, must not be nullpredicate
- the predicate to use for validation, must not be null
IllegalArgumentException
- if list or predicate is null
IllegalArgumentException
- if the list contains invalid elementsprotected List<E> decorated()
decorated
in class AbstractCollectionDecorator<E>
public E get(int index)
get
in interface List<E>
public int indexOf(Object object)
indexOf
in interface List<E>
public int lastIndexOf(Object object)
lastIndexOf
in interface List<E>
public E remove(int index)
remove
in interface List<E>
public void add(int index, E object)
add
in interface List<E>
public boolean addAll(int index, Collection<? extends E> coll)
addAll
in interface List<E>
public ListIterator<E> listIterator()
listIterator
in interface List<E>
public ListIterator<E> listIterator(int i)
listIterator
in interface List<E>
public E set(int index, E object)
set
in interface List<E>
public List<E> subList(int fromIndex, int toIndex)
subList
in interface List<E>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |