org.apache.commons.collections.list

Class PredicatedList

Implemented Interfaces:
Collection, List, Serializable

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.

Version:
$Revision: 1.6 $ $Date: 2004/06/03 22:02:13 $
Authors:
Stephen Colebourne
Paul Jack
Since:
Commons Collections 3.0

Nested Class Summary

protected class
PredicatedList.PredicatedListIterator
Inner class Iterator for the PredicatedList

Field Summary

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

predicate

Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator

collection

Constructor Summary

PredicatedList(List list, Predicate predicate)
Constructor that wraps (not copies).

Method Summary

void
add(int index, Object object)
boolean
addAll(int index, Collection coll)
static List
decorate(List list, Predicate predicate)
Factory method to create a predicated (validating) list.
Object
get(int index)
protected List
getList()
Gets the list being decorated.
int
indexOf(Object object)
int
lastIndexOf(Object object)
ListIterator
listIterator()
ListIterator
listIterator(int i)
Object
remove(int index)
Object
set(int index, Object object)
List
subList(int fromIndex, int toIndex)

Methods inherited from class org.apache.commons.collections.collection.PredicatedCollection

add, addAll, decorate, validate

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

add, addAll, clear, contains, containsAll, equals, getCollection, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

Constructor Details

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 null
predicate - the predicate to use for validation, must not be null

Method Details

add

public void add(int index,
                Object object)

addAll

public boolean addAll(int index,
                      Collection coll)

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 null
predicate - the predicate to use for validation, must not be null

get

public Object get(int index)

getList

protected List getList()
Gets the list being decorated.
Returns:
the decorated list

indexOf

public int indexOf(Object object)

lastIndexOf

public int lastIndexOf(Object object)

listIterator

public ListIterator listIterator()

listIterator

public ListIterator listIterator(int i)

remove

public Object remove(int index)

set

public Object set(int index,
                  Object object)

subList

public List subList(int fromIndex,
                    int toIndex)

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.