org.apache.commons.collections.map

Class UnmodifiableSortedMap

Implemented Interfaces:
Map, Serializable, SortedMap, Unmodifiable

public final class UnmodifiableSortedMap
extends AbstractSortedMapDecorator
implements Unmodifiable, Serializable

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

This class is Serializable from Commons Collections 3.1.

Version:
$Revision: 1.7 $ $Date: 2004/04/09 10:46:32 $
Author:
Stephen Colebourne
Since:
Commons Collections 3.0

Field Summary

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

comparator, firstKey, getSortedMap, headMap, lastKey, subMap, tailMap

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

clear, containsKey, containsValue, entrySet, equals, get, getMap, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

Method Details

clear

public void clear()
Overrides:
clear in interface AbstractMapDecorator

comparator

public Comparator comparator()
Overrides:
comparator in interface AbstractSortedMapDecorator

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

entrySet

public Set entrySet()
Overrides:
entrySet in interface AbstractMapDecorator

firstKey

public Object firstKey()
Overrides:
firstKey in interface AbstractSortedMapDecorator

headMap

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

keySet

public Set keySet()
Overrides:
keySet in interface AbstractMapDecorator

lastKey

public Object lastKey()
Overrides:
lastKey in interface AbstractSortedMapDecorator

put

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

putAll

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

remove

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

subMap

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

tailMap

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

values

public Collection values()
Overrides:
values in interface AbstractMapDecorator

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