public abstract class

AbstractSortedBidiMapDecorator

extends AbstractOrderedBidiMapDecorator
implements SortedBidiMap

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

Known Direct Subclasses

UnmodifiableSortedBidiMap

Class Overview

Provides a base decorator that enables additional functionality to be added to a SortedBidiMap via decoration.

Methods are forwarded directly to the decorated map.

This implementation does not perform any special processing with the map views. Instead it simply returns the inverse from the wrapped map. This may be undesirable, for example if you are trying to write a validating implementation it would provide a loophole around the validation. But, you might want that loophole, so this class is kept simple.

Summary

[Expand]

Inherited Fields

From class org.apache.commons.collections.map.AbstractMapDecorator

Public Constructors
	AbstractSortedBidiMapDecorator(SortedBidiMap map) Constructor that wraps (not copies).

Public Methods
Comparator	comparator()
SortedMap	headMap(Object toKey)
SortedBidiMap	inverseSortedBidiMap() Gets a view of this map where the keys and values are reversed.
SortedMap	subMap(Object fromKey, Object toKey)
SortedMap	tailMap(Object fromKey)

Protected Methods
SortedBidiMap	getSortedBidiMap() Gets the map being decorated.

[Expand]

Inherited Methods

From class org.apache.commons.collections.bidimap.AbstractOrderedBidiMapDecorator

From class org.apache.commons.collections.bidimap.AbstractBidiMapDecorator

From class org.apache.commons.collections.map.AbstractMapDecorator

From class java.lang.Object

From interface java.util.Map

abstract void	clear()
abstract boolean	containsKey(Object arg0)
abstract boolean	containsValue(Object arg0)
abstract Set<Entry<K, V>>	entrySet()
abstract boolean	equals(Object arg0)
abstract V	get(Object arg0)
abstract int	hashCode()
abstract boolean	isEmpty()
abstract Set<K>	keySet()
abstract V	put(K arg0, V arg1)
abstract void	putAll(Map<? extends K, ? extends V> arg0)
abstract V	remove(Object arg0)
abstract int	size()
abstract Collection<V>	values()

From interface java.util.SortedMap

From interface org.apache.commons.collections.BidiMap

From interface org.apache.commons.collections.IterableMap

From interface org.apache.commons.collections.OrderedBidiMap

From interface org.apache.commons.collections.OrderedMap

From interface org.apache.commons.collections.SortedBidiMap

Public Constructors

public AbstractSortedBidiMapDecorator (SortedBidiMap map)

Constructor that wraps (not copies).

Parameters

map	the map to decorate, must not be null

Throws

IllegalArgumentException	if the collection is null

Public Methods

public Comparator comparator ()

public SortedMap headMap (Object toKey)

public SortedBidiMap inverseSortedBidiMap ()

Gets a view of this map where the keys and values are reversed.

Changes to one map will be visible in the other and vice versa. This enables both directions of the map to be accessed as a SortedMap.

Implementations should seek to avoid creating a new object every time this method is called. See AbstractMap.values() etc. Calling this method on the inverse map should return the original.

The inverse map returned by inverseBidiMap() should be the same object as returned by this method.

Classes