org.apache.commons.collections.map

Class TypedMap


public class TypedMap
extends java.lang.Object

Decorates another Map 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.

The returned implementation is Serializable from Commons Collections 3.1.

Version:
$Revision: 1.6 $ $Date: 2004/05/07 23:17:13 $
Authors:
Stephen Colebourne
Matthew Hawthorne
Since:
Commons Collections 3.0

Constructor Summary

TypedMap()
Restrictive constructor.

Method Summary

static Map
decorate(Map map, Class keyType, Class valueType)
Factory method to create a typed map.

Constructor Details

TypedMap

protected TypedMap()
Restrictive constructor.

Method Details

decorate

public static Map decorate(Map map,
                           Class keyType,
                           Class valueType)
Factory method to create a typed map.

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

Parameters:
map - the map to decorate, must not be null
keyType - the type to allow as keys, must not be null
valueType - the type to allow as values, must not be null

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