⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.collections.map

Class TypedMap

java.lang.Object
|
+--org.apache.commons.collections.map.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.

Since:
Commons Collections 3.0
Authors:
Stephen Colebourne
Matthew Hawthorne

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
Throws:
- if list or type is null
- if the list contains invalid elements