org.apache.commons.collections.map
Class UnmodifiableSortedMap<K,V>

java.lang.Object
  org.apache.commons.collections.map.AbstractMapDecorator<K,V>
      org.apache.commons.collections.map.AbstractSortedMapDecorator<K,V>
          org.apache.commons.collections.map.UnmodifiableSortedMap<K,V>

All Implemented Interfaces:

Serializable, Map<K,V>, SortedMap<K,V>, Unmodifiable

public final class UnmodifiableSortedMap<K,V>
extends AbstractSortedMapDecorator<K,V>
implements Unmodifiable, Serializable

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

This class is Serializable from Commons Collections 3.1.

Since:

Commons Collections 3.0

Version:

$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:36:16 $

Author:

Matt Hall, John Watkinson, Stephen Colebourne

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator

map

Method Summary

void	clear()
Comparator<? super K>	comparator()
static <K,V> SortedMap<K,V>	decorate(SortedMap<K,V> map) Factory method to create an unmodifiable sorted map.
Set<Map.Entry<K,V>>	entrySet()
K	firstKey()
SortedMap<K,V>	headMap(K toKey)
Set<K>	keySet()
K	lastKey()
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> mapToCopy)
V	remove(Object key)
SortedMap<K,V>	subMap(K fromKey, K toKey)
SortedMap<K,V>	tailMap(K fromKey)
Collection<V>	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 <K,V> SortedMap<K,V> decorate(SortedMap<K,V> 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()

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class AbstractMapDecorator<K,V>

put

public V put(K key,
             V value)

Specified by:

put in interface Map<K,V>

Overrides:

put in class AbstractMapDecorator<K,V>

putAll

public void putAll(Map<? extends K,? extends V> mapToCopy)

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class AbstractMapDecorator<K,V>

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class AbstractMapDecorator<K,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

Overrides:

entrySet in class AbstractMapDecorator<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

Overrides:

keySet in class AbstractMapDecorator<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

Overrides:

values in class AbstractMapDecorator<K,V>

firstKey

public K firstKey()

Specified by:

firstKey in interface SortedMap<K,V>

Overrides:

firstKey in class AbstractSortedMapDecorator<K,V>

lastKey

public K lastKey()

Specified by:

lastKey in interface SortedMap<K,V>

Overrides:

lastKey in class AbstractSortedMapDecorator<K,V>

comparator

public Comparator<? super K> comparator()

Specified by:

comparator in interface SortedMap<K,V>

Overrides:

comparator in class AbstractSortedMapDecorator<K,V>

subMap

public SortedMap<K,V> subMap(K fromKey,
                             K toKey)

Specified by:

subMap in interface SortedMap<K,V>

Overrides:

subMap in class AbstractSortedMapDecorator<K,V>

headMap

public SortedMap<K,V> headMap(K toKey)

Specified by:

headMap in interface SortedMap<K,V>

Overrides:

headMap in class AbstractSortedMapDecorator<K,V>

tailMap

public SortedMap<K,V> tailMap(K fromKey)

Specified by:

tailMap in interface SortedMap<K,V>

Overrides:

tailMap in class AbstractSortedMapDecorator<K,V>