org.apache.commons.collections.bidimap

Class UnmodifiableSortedBidiMap

public final class UnmodifiableSortedBidiMap extends AbstractSortedBidiMapDecorator implements Unmodifiable

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

Since: Commons Collections 3.0

Version: $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $

Author: Stephen Colebourne

Method Summary
voidclear()
static SortedBidiMapdecorate(SortedBidiMap map)
Factory method to create an unmodifiable map.
SetentrySet()
SortedMapheadMap(Object toKey)
BidiMapinverseBidiMap()
OrderedBidiMapinverseOrderedBidiMap()
SortedBidiMapinverseSortedBidiMap()
SetkeySet()
MapIteratormapIterator()
OrderedMapIteratororderedMapIterator()
Objectput(Object key, Object value)
voidputAll(Map mapToCopy)
Objectremove(Object key)
ObjectremoveValue(Object value)
SortedMapsubMap(Object fromKey, Object toKey)
SortedMaptailMap(Object fromKey)
Collectionvalues()

Method Detail

clear

public void clear()

decorate

public static SortedBidiMap decorate(SortedBidiMap map)
Factory method to create an unmodifiable map.

If the map passed in is already unmodifiable, it is returned.

Parameters: map the map to decorate, must not be null

Returns: an unmodifiable SortedBidiMap

Throws: IllegalArgumentException if map is null

entrySet

public Set entrySet()

headMap

public SortedMap headMap(Object toKey)

inverseBidiMap

public BidiMap inverseBidiMap()

inverseOrderedBidiMap

public OrderedBidiMap inverseOrderedBidiMap()

inverseSortedBidiMap

public SortedBidiMap inverseSortedBidiMap()

keySet

public Set keySet()

mapIterator

public MapIterator mapIterator()

orderedMapIterator

public OrderedMapIterator orderedMapIterator()

put

public Object put(Object key, Object value)

putAll

public void putAll(Map mapToCopy)

remove

public Object remove(Object key)

removeValue

public Object removeValue(Object value)

subMap

public SortedMap subMap(Object fromKey, Object toKey)

tailMap

public SortedMap tailMap(Object fromKey)

values

public Collection values()
Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.