org.apache.commons.collections.bag
Class PredicatedSortedBag

java.lang.Object
  |
  +--org.apache.commons.collections.collection.AbstractCollectionDecorator
        |
        +--org.apache.commons.collections.collection.PredicatedCollection
              |
              +--org.apache.commons.collections.bag.PredicatedBag
                    |
                    +--org.apache.commons.collections.bag.PredicatedSortedBag
All Implemented Interfaces:
Bag, Collection, SortedBag

public class PredicatedSortedBag
extends PredicatedBag
implements SortedBag

Decorates another SortedBag to validate that additions match a specified predicate.

If an object cannot be added to the list, an IllegalArgumentException is thrown.

Since:
Commons Collections 3.0
Version:
$Revision: 1.3 $ $Date: 2004/01/14 21:43:08 $
Author:
Stephen Colebourne, Paul Jack

Fields inherited from class org.apache.commons.collections.collection.PredicatedCollection
predicate
 
Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator
collection
 
Constructor Summary
protected PredicatedSortedBag(SortedBag bag, Predicate predicate)
          Constructor that wraps (not copies).
 
Method Summary
 Comparator comparator()
          Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
static SortedBag decorate(SortedBag bag, Predicate predicate)
          Factory method to create a predicated (validating) bag.
 Object first()
          Returns the first (lowest) member.
protected  SortedBag getSortedBag()
          Gets the decorated sorted bag.
 Object last()
          Returns the last (highest) member.
 
Methods inherited from class org.apache.commons.collections.bag.PredicatedBag
add, decorate, getBag, getCount, remove, uniqueSet
 
Methods inherited from class org.apache.commons.collections.collection.PredicatedCollection
add, addAll, decorate, validate
 
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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.commons.collections.Bag
add, add, containsAll, getCount, iterator, remove, remove, removeAll, retainAll, size, uniqueSet
 
Methods inherited from interface java.util.Collection
addAll, clear, contains, equals, hashCode, isEmpty, toArray, toArray
 

Constructor Detail

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.

Parameters:
bag - the bag to decorate, must not be null
predicate - the predicate to use for validation, must not be null
Throws:
IllegalArgumentException - if bag or predicate is null
IllegalArgumentException - if the bag contains invalid elements
Method Detail

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.

Parameters:
bag - the bag to decorate, must not be null
predicate - the predicate to use for validation, must not be null
Throws:
IllegalArgumentException - if bag or predicate is null
IllegalArgumentException - if the bag contains invalid elements

getSortedBag

protected SortedBag getSortedBag()
Gets the decorated sorted bag.
Returns:
the decorated bag

first

public Object first()
Description copied from interface: SortedBag
Returns the first (lowest) member.
Specified by:
first in interface SortedBag
Following copied from interface: org.apache.commons.collections.SortedBag
Returns:
the first element in the sorted bag

last

public Object last()
Description copied from interface: SortedBag
Returns the last (highest) member.
Specified by:
last in interface SortedBag
Following copied from interface: org.apache.commons.collections.SortedBag
Returns:
the last element in the sorted bag

comparator

public Comparator comparator()
Description copied from interface: SortedBag
Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
Specified by:
comparator in interface SortedBag
Following copied from interface: org.apache.commons.collections.SortedBag
Returns:
the comparator in use, or null if natural ordering


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