⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.collections.bidimap

Class UnmodifiableSortedBidiMap

java.lang.Object
|
+--org.apache.commons.collections.map.AbstractMapDecorator
   |
   +--org.apache.commons.collections.bidimap.AbstractBidiMapDecorator
      |
      +--org.apache.commons.collections.bidimap.AbstractOrderedBidiMapDecorator
         |
         +--org.apache.commons.collections.bidimap.AbstractSortedBidiMapDecorator
            |
            +--org.apache.commons.collections.bidimap.UnmodifiableSortedBidiMap

All Implemented Interfaces:
Map, BidiMap, OrderedBidiMap, SortedBidiMap, Unmodifiable


public final class UnmodifiableSortedBidiMap
extends AbstractSortedBidiMapDecorator
implements Unmodifiable

Decorates another SortedBidiMap to ensure it can't be altered.
Since:
Commons Collections 3.0
Author:
Stephen Colebourne

Method Summary

void

clear()

static SortedBidiMap

decorate(SortedBidiMap map)

Factory method to create an unmodifiable map.

Set

entrySet()

SortedMap

headMap(Object toKey)

BidiMap

inverseBidiMap()

OrderedBidiMap

inverseOrderedBidiMap()

SortedBidiMap

inverseSortedBidiMap()

Set

keySet()

MapIterator

mapIterator()

OrderedMapIterator

orderedMapIterator()

Object

put(Object key, Object value)

void

putAll(Map mapToCopy)

Object

remove(Object key)

Object

removeValue(Object value)

SortedMap

subMap(Object fromKey, Object toKey)

SortedMap

tailMap(Object fromKey)

Collection

values()

Method Details

clear

public void clear()


decorate

public static SortedBidiMap decorate(SortedBidiMap map)

Factory method to create an unmodifiable map.

Parameters:
map - the map to decorate, must not be null
Throws:
- if map is null

entrySet

public Set entrySet()


headMap

public SortedMap headMap(Object toKey)

Parameters:
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)

Parameters:
key
value

putAll

public void putAll(Map mapToCopy)

Parameters:
mapToCopy

remove

public Object remove(Object key)

Parameters:
key

removeValue

public Object removeValue(Object value)

Parameters:
value

subMap

public SortedMap subMap(Object fromKey, Object toKey)

Parameters:
fromKey
toKey

tailMap

public SortedMap tailMap(Object fromKey)

Parameters:
fromKey

values

public Collection values()