org.apache.commons.collections.list
Class PredicatedList
java.lang.Object
org.apache.commons.collections.collection.AbstractCollectionDecorator
org.apache.commons.collections.collection.AbstractSerializableCollectionDecorator
org.apache.commons.collections.collection.PredicatedCollection
org.apache.commons.collections.list.PredicatedList
- All Implemented Interfaces:
- Serializable, Iterable, Collection, List
public class PredicatedList
- extends PredicatedCollection
- implements List
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:
- Commons Collections 3.0
- Version:
- $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
- Author:
- Stephen Colebourne, Paul Jack
- See Also:
- Serialized Form
Methods inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator |
clear, contains, containsAll, equals, getCollection, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString |
Methods inherited from interface java.util.List |
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray |
PredicatedList
protected PredicatedList(List list,
Predicate 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:
IllegalArgumentException
- if list or predicate is null
IllegalArgumentException
- if the list contains invalid elements
decorate
public static List decorate(List list,
Predicate predicate)
- Factory method to create a predicated (validating) list.
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:
IllegalArgumentException
- if list or predicate is null
IllegalArgumentException
- if the list contains invalid elements
getList
protected List getList()
- Gets the list being decorated.
- Returns:
- the decorated list
get
public Object get(int index)
- Specified by:
get
in interface List
indexOf
public int indexOf(Object object)
- Specified by:
indexOf
in interface List
lastIndexOf
public int lastIndexOf(Object object)
- Specified by:
lastIndexOf
in interface List
remove
public Object remove(int index)
- Specified by:
remove
in interface List
add
public void add(int index,
Object object)
- Specified by:
add
in interface List
addAll
public boolean addAll(int index,
Collection coll)
- Specified by:
addAll
in interface List
listIterator
public ListIterator listIterator()
- Specified by:
listIterator
in interface List
listIterator
public ListIterator listIterator(int i)
- Specified by:
listIterator
in interface List
set
public Object set(int index,
Object object)
- Specified by:
set
in interface List
subList
public List subList(int fromIndex,
int toIndex)
- Specified by:
subList
in interface List
Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.