org.apache.commons.collections.map
Class TypedSortedMap

java.lang.Object
  extended by org.apache.commons.collections.map.TypedSortedMap

public class TypedSortedMap
extends java.lang.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.

The returned implementation is Serializable from Commons Collections 3.1.

Since:
Commons Collections 3.0
Version:
$Revision: 1.6 $ $Date: 2004/05/07 23:18:26 $
Author:
Stephen Colebourne, Matthew Hawthorne

Constructor Summary
protected TypedSortedMap()
          Restrictive constructor.
 
Method Summary
static java.util.SortedMap decorate(java.util.SortedMap map, java.lang.Class keyType, java.lang.Class valueType)
          Factory method to create a typed sorted map.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TypedSortedMap

protected TypedSortedMap()
Restrictive constructor.

Method Detail

decorate

public static java.util.SortedMap decorate(java.util.SortedMap map,
                                           java.lang.Class keyType,
                                           java.lang.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:
java.lang.IllegalArgumentException - if list or type is null
java.lang.IllegalArgumentException - if the list contains invalid elements


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