org.apache.commons.collections.bag
Class PredicatedSortedBag
- Bag, Collection, Bag, Serializable, SortedBag
public class PredicatedSortedBag
Decorates another
SortedBag
to validate that additions
match a specified predicate.
This bag exists to provide validation for the decorated bag.
It is normally created to decorate an empty bag.
If an object cannot be added to the bag, an IllegalArgumentException is thrown.
One usage would be to ensure that no null entries are added to the bag.
SortedBag bag = PredicatedSortedBag.decorate(new TreeBag(), NotNullPredicate.INSTANCE);
This class is Serializable from Commons Collections 3.1.
$Revision: 1.8 $ $Date: 2004/06/03 22:02:12 $- Stephen Colebourne
- Paul Jack
add , addAll , clear , contains , containsAll , equals , getCollection , hashCode , isEmpty , iterator , remove , removeAll , retainAll , size , toArray , toArray , toString |
PredicatedSortedBag
protected PredicatedSortedBag(SortedBag bag,
Predicate predicate)
Constructor that wraps (not copies).
If there are any elements already in the bag being decorated, they
are validated.
bag
- the bag to decorate, must not be nullpredicate
- the predicate to use for validation, must not be null
decorate
public static SortedBag decorate(SortedBag bag,
Predicate predicate)
Factory method to create a predicated (validating) bag.
If there are any elements already in the bag being decorated, they
are validated.
bag
- the bag to decorate, must not be nullpredicate
- the predicate to use for validation, must not be null
- a new predicated SortedBag
getSortedBag
protected SortedBag getSortedBag()
Gets the decorated sorted bag.
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.