|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.google.common.collect.ImmutableMap<K,V>
com.google.common.collect.ImmutableBiMap<K,V>
@GwtCompatible(serializable=true,
emulated=true)
public abstract class ImmutableBiMap<K,V>
An immutable BiMap with reliable user-specified iteration order. Does
not permit null keys or values. An ImmutableBiMap and its inverse
have the same iteration ordering.
An instance of ImmutableBiMap contains its own data and will
never change. ImmutableBiMap is convenient for
public static final maps ("constant maps") and also lets you easily
make a "defensive copy" of a bimap provided to your class by a caller.
Note: Although this class is not final, it cannot be subclassed as it has no public or protected constructors. Thus, instances of this class are guaranteed to be immutable.
| Nested Class Summary | |
|---|---|
static class |
ImmutableBiMap.Builder<K,V>
A builder for creating immutable bimap instances, especially public
static final bimaps ("constant bimaps"). |
| Nested classes/interfaces inherited from interface java.util.Map |
|---|
Map.Entry<K,V> |
| Method Summary | ||
|---|---|---|
static
|
builder()
Returns a new builder. |
|
boolean |
containsKey(Object key)
|
|
boolean |
containsValue(Object value)
|
|
static
|
copyOf(Map<? extends K,? extends V> map)
Returns an immutable bimap containing the same entries as map. |
|
ImmutableSet<Map.Entry<K,V>> |
entrySet()
Returns an immutable set of the mappings in this map. |
|
boolean |
equals(Object object)
|
|
V |
forcePut(K key,
V value)
Guaranteed to throw an exception and leave the bimap unmodified. |
|
V |
get(Object key)
|
|
int |
hashCode()
|
|
abstract ImmutableBiMap<V,K> |
inverse()
Returns the inverse view of this bimap, which maps each of this bimap's values to its associated key. |
|
boolean |
isEmpty()
|
|
ImmutableSet<K> |
keySet()
Returns an immutable set of the keys in this map. |
|
static
|
of()
Returns the empty bimap. |
|
static
|
of(K k1,
V v1)
Returns an immutable bimap containing a single entry. |
|
static
|
of(K k1,
V v1,
K k2,
V v2)
Returns an immutable map containing the given entries, in order. |
|
static
|
of(K k1,
V v1,
K k2,
V v2,
K k3,
V v3)
Returns an immutable map containing the given entries, in order. |
|
static
|
of(K k1,
V v1,
K k2,
V v2,
K k3,
V v3,
K k4,
V v4)
Returns an immutable map containing the given entries, in order. |
|
static
|
of(K k1,
V v1,
K k2,
V v2,
K k3,
V v3,
K k4,
V v4,
K k5,
V v5)
Returns an immutable map containing the given entries, in order. |
|
int |
size()
|
|
String |
toString()
|
|
ImmutableSet<V> |
values()
Returns an immutable set of the values in this map. |
|
| Methods inherited from class com.google.common.collect.ImmutableMap |
|---|
clear, put, putAll, remove |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.google.common.collect.BiMap |
|---|
put, putAll |
| Methods inherited from interface java.util.Map |
|---|
clear, remove |
| Method Detail |
|---|
public static <K,V> ImmutableBiMap<K,V> of()
public static <K,V> ImmutableBiMap<K,V> of(K k1,
V v1)
public static <K,V> ImmutableBiMap<K,V> of(K k1,
V v1,
K k2,
V v2)
IllegalArgumentException - if duplicate keys or values are added
public static <K,V> ImmutableBiMap<K,V> of(K k1,
V v1,
K k2,
V v2,
K k3,
V v3)
IllegalArgumentException - if duplicate keys or values are added
public static <K,V> ImmutableBiMap<K,V> of(K k1,
V v1,
K k2,
V v2,
K k3,
V v3,
K k4,
V v4)
IllegalArgumentException - if duplicate keys or values are added
public static <K,V> ImmutableBiMap<K,V> of(K k1,
V v1,
K k2,
V v2,
K k3,
V v3,
K k4,
V v4,
K k5,
V v5)
IllegalArgumentException - if duplicate keys or values are addedpublic static <K,V> ImmutableBiMap.Builder<K,V> builder()
ImmutableBiMap.Builder constructor.
public static <K,V> ImmutableBiMap<K,V> copyOf(Map<? extends K,? extends V> map)
map. If
map somehow contains entries with duplicate keys (for example, if
it is a SortedMap whose comparator is not consistent with
equals), the results of this method are undefined.
Despite the method name, this method attempts to avoid actually copying the data when it is safe to do so. The exact circumstances under which a copy will or will not be performed are undocumented and subject to change.
IllegalArgumentException - if two keys have the same value
NullPointerException - if any key or value in map is nullpublic abstract ImmutableBiMap<V,K> inverse()
Note:There is no guaranteed correspondence between the iteration order of a bimap and that of its inverse.
The inverse of an ImmutableBiMap is another
ImmutableBiMap.
inverse in interface BiMap<K,V>
public boolean containsKey(@Nullable
Object key)
containsKey in interface Map<K,V>containsKey in class ImmutableMap<K,V>
public boolean containsValue(@Nullable
Object value)
containsValue in interface Map<K,V>containsValue in class ImmutableMap<K,V>public ImmutableSet<Map.Entry<K,V>> entrySet()
ImmutableMap
entrySet in interface Map<K,V>entrySet in class ImmutableMap<K,V>
public V get(@Nullable
Object key)
get in interface Map<K,V>get in class ImmutableMap<K,V>public ImmutableSet<K> keySet()
ImmutableMap
keySet in interface Map<K,V>keySet in class ImmutableMap<K,V>public ImmutableSet<V> values()
values in interface BiMap<K,V>values in interface Map<K,V>values in class ImmutableMap<K,V>
public V forcePut(K key,
V value)
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 entry
UnsupportedOperationException - alwayspublic boolean isEmpty()
isEmpty in interface Map<K,V>isEmpty in class ImmutableMap<K,V>public int size()
size in interface Map<K,V>
public boolean equals(@Nullable
Object object)
equals in interface Map<K,V>equals in class ImmutableMap<K,V>public int hashCode()
hashCode in interface Map<K,V>hashCode in class ImmutableMap<K,V>public String toString()
toString in class ImmutableMap<K,V>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||