org.apache.commons.collections.collection
Class TypedCollection

java.lang.Object
  |
  +--org.apache.commons.collections.collection.TypedCollection

public class TypedCollection
extends Object

Decorates a Collection 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.2 $ $Date: 2004/01/14 21:43:18 $
Author:
Stephen Colebourne, Matthew Hawthorne

Constructor Summary
protected TypedCollection()
          Restrictive constructor.
 
Method Summary
static Collection decorate(Collection coll, Class type)
          Factory method to create a typed collection.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TypedCollection

protected TypedCollection()
Restrictive constructor.
Method Detail

decorate

public static Collection decorate(Collection coll,
                                  Class type)
Factory method to create a typed collection.

If there are any elements already in the collection being decorated, they are validated.

Parameters:
coll - the collection to decorate, must not be null
type - the type to allow into the collection, must not be null
Throws:
IllegalArgumentException - if collection or type is null
IllegalArgumentException - if the collection contains invalid elements


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