org.apache.commons.collections.collection
Class TypedCollection

java.lang.Object
  org.apache.commons.collections.collection.TypedCollection

public class TypedCollection
extends java.lang.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: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $

Author:

Stephen Colebourne, Matthew Hawthorne

Constructor Summary

protected

TypedCollection() Restrictive constructor.

Method Summary

static java.util.Collection

decorate(java.util.Collection coll, java.lang.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 java.util.Collection decorate(java.util.Collection coll,
                                            java.lang.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

Returns:

a new typed collection

Throws:

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

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