org.apache.commons.collections.bag
Class TypedBag

java.lang.Object
  |
  +--org.apache.commons.collections.bag.TypedBag

public class TypedBag

extends java.lang.Object

Decorates another Bag to validate that elements added are of a specific type.

The validation of additions is performed via an instanceof test against a specified Class. If an object cannot be added to the collection, an IllegalArgumentException is thrown.

Since:

Commons Collections 3.0

Version:

$Revision: 1.6 $ $Date: 2004/05/15 12:27:04 $

Author:

Stephen Colebourne, Matthew Hawthorne

Method Summary

static Bag

decorate(Bag bag, java.lang.Class type) Factory method to create a typed bag.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

decorate

public static Bag decorate(Bag bag,
                           java.lang.Class type)

Factory method to create a typed 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

type - the type to allow into the bag, must not be null

Returns:

a new typed Bag

Throws:

java.lang.IllegalArgumentException - if bag or type is null

java.lang.IllegalArgumentException - if the bag contains invalid elements