org.apache.commons.collections.map

Class TypedSortedMap

public class TypedSortedMap extends Object

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

Note that TypedSortedMap is not synchronized and is not thread-safe. If you wish to use this map from multiple threads concurrently, you must use appropriate synchronization. The simplest approach is to wrap this map using java.util.Collections#synchronizedSortedMap. This class may throw exceptions when accessed by concurrent threads without synchronization.

The returned implementation is Serializable from Commons Collections 3.1.

Since: Commons Collections 3.0

Version: $Revision: 348007 $ $Date: 2005-11-21 22:52:57 +0000 (Mon, 21 Nov 2005) $

Author: Stephen Colebourne Matthew Hawthorne

Constructor Summary
protected TypedSortedMap()
Restrictive constructor.
Method Summary
static SortedMapdecorate(SortedMap map, Class keyType, Class valueType)
Factory method to create a typed sorted map.

Constructor Detail

TypedSortedMap

protected TypedSortedMap()
Restrictive constructor.

Method Detail

decorate

public static SortedMap decorate(SortedMap map, Class keyType, Class valueType)
Factory method to create a typed sorted 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: IllegalArgumentException if list or type is null IllegalArgumentException if the list contains invalid elements

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