|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.common.collect.ForwardingObject
com.google.common.collect.ForwardingMap<K,V>
com.google.common.collect.EnumBiMap<K,V>
public final class EnumBiMap<K extends Enum<K>,V extends Enum<V>>
A BiMap
backed by two EnumMap
instances. Null keys and values
are not permitted.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface java.util.Map |
---|
Map.Entry<K,V> |
Constructor Summary | |
---|---|
EnumBiMap(Class<K> keyType,
Class<V> valueType)
Constructs a new empty bimap using the specified key type and value type. |
|
EnumBiMap(EnumBiMap<K,V> map)
Constructs a new bimap with the same mappings as the specified map. |
|
EnumBiMap(Map<K,V> map)
Constructs a new bimap with the same mappings as the specified map. |
Method Summary | |
---|---|
void |
clear()
|
boolean |
containsValue(Object value)
|
Set<Map.Entry<K,V>> |
entrySet()
|
V |
forcePut(K key,
V value)
An alternate form of put that silently removes any existing entry
with the value value before proceeding with the BiMap.put(K, V)
operation. |
BiMap<V,K> |
inverse()
Returns the inverse view of this bimap, which maps each of this bimap's values to its associated key. |
Set<K> |
keySet()
|
Class<K> |
keyType()
Returns the associated key type. |
V |
put(K key,
V value)
|
void |
putAll(Map<? extends K,? extends V> map)
|
V |
remove(Object key)
|
Set<V> |
values()
|
Class<V> |
valueType()
Returns the associated value type. |
Methods inherited from class com.google.common.collect.ForwardingMap |
---|
containsKey, delegate, equals, get, hashCode, isEmpty, size |
Methods inherited from class com.google.common.collect.ForwardingObject |
---|
toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Map |
---|
containsKey, equals, get, hashCode, isEmpty, size |
Constructor Detail |
---|
public EnumBiMap(Class<K> keyType, Class<V> valueType)
keyType
- the key typevalueType
- the value typepublic EnumBiMap(EnumBiMap<K,V> map)
map
- the map whose mappings are to be placed in this mappublic EnumBiMap(Map<K,V> map)
EnumBiMap
instance, this constructor behaves
identically to EnumBiMap(EnumBiMap)
. Otherwise, the specified map
must contain at least one mapping (in order to determine the new enum
bimap's key and value types).
map
- the map whose mappings are to be placed in this map
IllegalArgumentException
- if map is not an EnumBiMap
instance and contains no mappingsMethod Detail |
---|
public Class<K> keyType()
public Class<V> valueType()
public boolean containsValue(Object value)
containsValue
in interface Map<K,V>
containsValue
in class ForwardingMap<K,V>
public V put(K key, V value)
BiMap
put
in interface BiMap<K,V>
put
in interface Map<K,V>
put
in class ForwardingMap<K,V>
public V forcePut(K key, V value)
BiMap
put
that silently removes any existing entry
with the value value
before proceeding with the BiMap.put(K, V)
operation. If the bimap previously contained the provided key-value
mapping, this method has no effect.
Note that a successful call to this method could cause the size of the bimap to increase by one, stay the same, or even decrease by one.
Warning: If an existing entry with this value is removed, the key for that entry is discarded and not returned.
forcePut
in interface BiMap<K,V>
key
- the key with which the specified value is to be associatedvalue
- the value to be associated with the specified key
null
, or null
if there was no previous entrypublic V remove(Object key)
remove
in interface Map<K,V>
remove
in class ForwardingMap<K,V>
public void putAll(Map<? extends K,? extends V> map)
BiMap
Warning: the results of calling this method may vary depending on
the iteration order of map
.
putAll
in interface BiMap<K,V>
putAll
in interface Map<K,V>
putAll
in class ForwardingMap<K,V>
public void clear()
clear
in interface Map<K,V>
clear
in class ForwardingMap<K,V>
public BiMap<V,K> inverse()
BiMap
Note:There is no guaranteed correspondence between the iteration order of a bimap and that of its inverse.
inverse
in interface BiMap<K,V>
public Set<K> keySet()
keySet
in interface Map<K,V>
keySet
in class ForwardingMap<K,V>
public Set<V> values()
BiMap
Because a bimap has unique values, this method returns a Set
,
instead of the Collection
specified in the Map
interface.
values
in interface BiMap<K,V>
values
in interface Map<K,V>
values
in class ForwardingMap<K,V>
public Set<Map.Entry<K,V>> entrySet()
entrySet
in interface Map<K,V>
entrySet
in class ForwardingMap<K,V>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |