org.apache.commons.collections15.bidimap
Class AbstractSortedBidiMapDecorator<K,V>
java.lang.Object
org.apache.commons.collections15.map.AbstractMapDecorator<K,V>
org.apache.commons.collections15.bidimap.AbstractBidiMapDecorator<K,V>
org.apache.commons.collections15.bidimap.AbstractOrderedBidiMapDecorator<K,V>
org.apache.commons.collections15.bidimap.AbstractSortedBidiMapDecorator<K,V>
- All Implemented Interfaces:
- Map<K,V>, SortedMap<K,V>, BidiMap<K,V>, IterableMap<K,V>, OrderedBidiMap<K,V>, OrderedMap<K,V>, SortedBidiMap<K,V>
- Direct Known Subclasses:
- UnmodifiableSortedBidiMap
public abstract class AbstractSortedBidiMapDecorator<K,V>
- extends AbstractOrderedBidiMapDecorator<K,V>
- implements SortedBidiMap<K,V>
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.
- Since:
- Commons Collections 3.0
- Version:
- $Revision: 1.1 $ $Date: 2005/10/11 17:05:19 $
- Author:
- Matt Hall, John Watkinson, Stephen Colebourne
Nested classes/interfaces inherited from interface java.util.Map |
Map.Entry<K,V> |
Methods inherited from class org.apache.commons.collections15.map.AbstractMapDecorator |
clear, containsKey, containsValue, entrySet, equals, get, getMap, hashCode, isEmpty, keySet, put, putAll, remove, size, toString |
Methods inherited from interface java.util.Map |
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, putAll, remove, size |
AbstractSortedBidiMapDecorator
public AbstractSortedBidiMapDecorator(SortedBidiMap<K,V> map)
- Constructor that wraps (not copies).
- Parameters:
map
- the map to decorate, must not be null
- Throws:
IllegalArgumentException
- if the collection is null
getSortedBidiMap
protected SortedBidiMap<K,V> getSortedBidiMap()
- Gets the map being decorated.
- Returns:
- the decorated map
inverseSortedBidiMap
public SortedBidiMap<V,K> inverseSortedBidiMap()
- Description copied from interface:
SortedBidiMap
- 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.
- Specified by:
inverseSortedBidiMap
in interface SortedBidiMap<K,V>
- Returns:
- an inverted bidirectional map
comparator
public Comparator<? super K> comparator()
- Specified by:
comparator
in interface SortedMap<K,V>
subMap
public SortedMap<K,V> subMap(K fromKey,
K toKey)
- Specified by:
subMap
in interface SortedMap<K,V>
headMap
public SortedMap<K,V> headMap(K toKey)
- Specified by:
headMap
in interface SortedMap<K,V>
tailMap
public SortedMap<K,V> tailMap(K fromKey)
- Specified by:
tailMap
in interface SortedMap<K,V>
Copyright © 2001-2010 Apache Software Foundation. All Rights Reserved.