org.apache.commons.collections.map
Class UnmodifiableSortedMap

java.lang.Object
  |
  +--org.apache.commons.collections.map.AbstractMapDecorator
        |
        +--org.apache.commons.collections.map.AbstractSortedMapDecorator
              |
              +--org.apache.commons.collections.map.UnmodifiableSortedMap
All Implemented Interfaces:
Map, SortedMap, Unmodifiable

public final class UnmodifiableSortedMap
extends AbstractSortedMapDecorator
implements Unmodifiable

Decorates another SortedMap to ensure it can't be altered.

Since:
Commons Collections 3.0
Version:
$Revision: 1.5 $ $Date: 2004/01/14 21:43:11 $
Author:
Stephen Colebourne

Inner classes inherited from class java.util.Map
Map.Entry
 
Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator
map
 
Method Summary
 void clear()
           
 Comparator comparator()
           
static SortedMap decorate(SortedMap map)
          Factory method to create an unmodifiable sorted map.
 Set entrySet()
           
 Object firstKey()
           
 SortedMap headMap(Object toKey)
           
 Set keySet()
           
 Object lastKey()
           
 Object put(Object key, Object value)
           
 void putAll(Map mapToCopy)
           
 Object remove(Object key)
           
 SortedMap subMap(Object fromKey, Object toKey)
           
 SortedMap tailMap(Object fromKey)
           
 Collection values()
           
 
Methods inherited from class org.apache.commons.collections.map.AbstractSortedMapDecorator
getSortedMap
 
Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator
containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, size, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
containsKey, containsValue, equals, get, hashCode, isEmpty, size
 

Method Detail

decorate

public static SortedMap decorate(SortedMap map)
Factory method to create an unmodifiable sorted map.
Parameters:
map - the map to decorate, must not be null
Throws:
IllegalArgumentException - if map is null

clear

public void clear()
Overrides:
clear in class AbstractMapDecorator

put

public Object put(Object key,
                  Object value)
Overrides:
put in class AbstractMapDecorator

putAll

public void putAll(Map mapToCopy)
Overrides:
putAll in class AbstractMapDecorator

remove

public Object remove(Object key)
Overrides:
remove in class AbstractMapDecorator

entrySet

public Set entrySet()
Overrides:
entrySet in class AbstractMapDecorator

keySet

public Set keySet()
Overrides:
keySet in class AbstractMapDecorator

values

public Collection values()
Overrides:
values in class AbstractMapDecorator

firstKey

public Object firstKey()
Overrides:
firstKey in class AbstractSortedMapDecorator

lastKey

public Object lastKey()
Overrides:
lastKey in class AbstractSortedMapDecorator

comparator

public Comparator comparator()
Overrides:
comparator in class AbstractSortedMapDecorator

subMap

public SortedMap subMap(Object fromKey,
                        Object toKey)
Overrides:
subMap in class AbstractSortedMapDecorator

headMap

public SortedMap headMap(Object toKey)
Overrides:
headMap in class AbstractSortedMapDecorator

tailMap

public SortedMap tailMap(Object fromKey)
Overrides:
tailMap in class AbstractSortedMapDecorator


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