Guava: Google Core Libraries for Java 33.1.0-jre · com.google.common.collect.ImmutableEnumMap

Modifier and Type	Class and Description
private static class	ImmutableEnumMap.EnumSerializedForm<K extends Enum<K>, V>

Modifier and Type	Field and Description
private final transient EnumMap<K, V>	delegate

Access	Constructor and Description
private	ImmutableEnumMap(EnumMap<K, V> delegate)

Method Summary

Modifier and Type	Method and Description
pack-priv static <K extends Enum<K>, V> ImmutableMap<K, V>	asImmutable(EnumMap<K, V> map)
public boolean	containsKey(Object key whose presence in this map is to be tested key) Overrides com.google.common.collect.ImmutableMap.containsKey. Implements java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key.
pack-priv UnmodifiableIterator<Map.Entry<K, V>>	entryIterator() Implements abstract com.google.common.collect.ImmutableMap.IteratorBasedImmutableMap.entryIterator.
pack-priv Spliterator<Map.Entry<K, V>>	entrySpliterator() Overrides com.google.common.collect.ImmutableMap.IteratorBasedImmutableMap.entrySpliterator.
public boolean	equals(Object object to be compared for equality with this map object) Overrides com.google.common.collect.ImmutableMap.equals. Implements java.util.Map.equals. Compares the specified object with this map for equality.
public void	forEach(BiConsumer<? super K, ? super V> The action to be performed for each entry action) Overrides default java.util.Map.forEach. Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.
public V	get(Object the key whose associated value is to be returned key) Implements abstract com.google.common.collect.ImmutableMap.get. Implements java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
pack-priv boolean	isPartialView() Implements abstract com.google.common.collect.ImmutableMap.isPartialView.
pack-priv UnmodifiableIterator<K>	keyIterator() Overrides com.google.common.collect.ImmutableMap.keyIterator.
pack-priv Spliterator<K>	keySpliterator() Overrides com.google.common.collect.ImmutableMap.keySpliterator.
private void	readObject(ObjectInputStream stream) Hides com.google.common.collect.ImmutableMap.readObject.
public int	size() Implements java.util.Map.size. Returns the number of key-value mappings in this map.
pack-priv Object	writeReplace() Overrides com.google.common.collect.ImmutableMap.IteratorBasedImmutableMap.writeReplace. Returns a serializable form of this object.

Inherited from com.google.common.collect.ImmutableMap.IteratorBasedImmutableMap:: createEntrySet createKeySet createValues

delegate	back to summary
private final transient EnumMap<K, V> delegate

ImmutableEnumMap	back to summary
private ImmutableEnumMap(EnumMap<K, V> delegate)

Method Detail

asImmutable	back to summary
pack-priv static <K extends Enum<K>, V> ImmutableMap<K, V> asImmutable(EnumMap<K, V> map)

containsKey back to summary

containsKey	back to summary
public boolean containsKey(Object key) Overrides com.google.common.collect.ImmutableMap.containsKey. Implements java.util.Map.containsKey. Doc from java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key. More formally, returns `true` if and only if this map contains a mapping for a key `k` such that `Objects.equals(key, k)`. (There can be at most one such mapping.) Parameters key:Object key whose presence in this map is to be tested Returns:boolean `true` if this map contains a mapping for the specified key Annotations @Override

public boolean containsKey(Object key)

Overrides com.google.common.collect.ImmutableMap.containsKey.

Implements java.util.Map.containsKey.

Doc from java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Parameters

key:Object: key whose presence in this map is to be tested

Returns:boolean

true if this map contains a mapping for the specified key

Annotations

@Override

entryIterator	back to summary
pack-priv UnmodifiableIterator<Map.Entry<K, V>> entryIterator() Implements abstract com.google.common.collect.ImmutableMap.IteratorBasedImmutableMap.entryIterator. Annotations @Override

entryIterator

back to summary

pack-priv UnmodifiableIterator<Map.Entry<K, V>> entryIterator()

Implements abstract com.google.common.collect.ImmutableMap.IteratorBasedImmutableMap.entryIterator.

Annotations

@Override

entrySpliterator	back to summary
pack-priv Spliterator<Map.Entry<K, V>> entrySpliterator() Overrides com.google.common.collect.ImmutableMap.IteratorBasedImmutableMap.entrySpliterator. Annotations @Override

entrySpliterator

back to summary

pack-priv Spliterator<Map.Entry<K, V>> entrySpliterator()

Overrides com.google.common.collect.ImmutableMap.IteratorBasedImmutableMap.entrySpliterator.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides com.google.common.collect.ImmutableMap.equals. Implements java.util.Map.equals. Doc from java.util.Map.equals. Compares the specified object with this map for equality. Returns `true` if the given object is also a map and the two maps represent the same mappings. More formally, two maps `m1` and `m2` represent the same mappings if `m1.entrySet().equals(m2.entrySet())`. This ensures that the `equals` method works properly across different implementations of the `Map` interface. Parameters object:Object object to be compared for equality with this map Returns:boolean `true` if the specified object is equal to this map Annotations @Override

public boolean equals(Object object)

Overrides com.google.common.collect.ImmutableMap.equals.

Implements java.util.Map.equals.

Doc from java.util.Map.equals.

Compares the specified object with this map for equality. Returns true if the given object is also a map and the two maps represent the same mappings. More formally, two maps m1 and m2 represent the same mappings if m1.entrySet().equals(m2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.

Parameters

object:Object: object to be compared for equality with this map

Returns:boolean

true if the specified object is equal to this map

Annotations

@Override

forEach	back to summary
public void forEach(BiConsumer<? super K, ? super V> action) Overrides default java.util.Map.forEach. Doc from java.util.Map.forEach. Performs the given action for each entry in this map until all entries have been processed or the action throws an exception. Unless otherwise specified by the implementing class, actions are performed in the order of entry set iteration (if an iteration order is specified.) Exceptions thrown by the action are relayed to the caller. Parameters action:BiConsumer<? super K, ? super V> The action to be performed for each entry Annotations @Override

forEach

back to summary

public void forEach(BiConsumer<? super K, ? super V> action)

Overrides default java.util.Map.forEach.

Doc from java.util.Map.forEach.

Performs the given action for each entry in this map until all entries have been processed or the action throws an exception. Unless otherwise specified by the implementing class, actions are performed in the order of entry set iteration (if an iteration order is specified.) Exceptions thrown by the action are relayed to the caller.

Parameters

action:BiConsumer<? super K, ? super V>: The action to be performed for each entry

Annotations

@Override

get back to summary

get	back to summary
public V get(Object key) Implements abstract com.google.common.collect.ImmutableMap.get. Implements java.util.Map.get. Doc from java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. More formally, if this map contains a mapping from a key `k` to a value `v` such that `Objects.equals(key, k)`, then this method returns `v`; otherwise it returns `null`. (There can be at most one such mapping.) If this map permits null values, then a return value of `null` does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to `null`. The `containsKey` operation may be used to distinguish these two cases. Parameters key:Object the key whose associated value is to be returned Returns:V the value to which the specified key is mapped, or `null` if this map contains no mapping for the key Annotations @Override @CheckForNull

public V get(Object key)

Implements abstract com.google.common.collect.ImmutableMap.get.

Implements java.util.Map.get.

Doc from java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters

key:Object: the key whose associated value is to be returned

Returns:V

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Annotations

@Override
@CheckForNull

isPartialView	back to summary
pack-priv boolean isPartialView() Implements abstract com.google.common.collect.ImmutableMap.isPartialView. Annotations @Override

isPartialView

back to summary

pack-priv boolean isPartialView()

Implements abstract com.google.common.collect.ImmutableMap.isPartialView.

Annotations

@Override

keyIterator	back to summary
pack-priv UnmodifiableIterator<K> keyIterator() Overrides com.google.common.collect.ImmutableMap.keyIterator. Annotations @Override

keyIterator

back to summary

pack-priv UnmodifiableIterator<K> keyIterator()

Overrides com.google.common.collect.ImmutableMap.keyIterator.

Annotations

@Override

keySpliterator	back to summary
pack-priv Spliterator<K> keySpliterator() Overrides com.google.common.collect.ImmutableMap.keySpliterator. Annotations @Override

keySpliterator

back to summary

pack-priv Spliterator<K> keySpliterator()

Overrides com.google.common.collect.ImmutableMap.keySpliterator.

Annotations

@Override

readObject	back to summary
private void readObject(ObjectInputStream stream) throws InvalidObjectException Hides com.google.common.collect.ImmutableMap.readObject. Annotations @J2ktIncompatible

readObject

back to summary

private void readObject(ObjectInputStream stream) throws InvalidObjectException

Hides com.google.common.collect.ImmutableMap.readObject.

Annotations

@J2ktIncompatible

size back to summary

size	back to summary
public int size() Implements java.util.Map.size. Doc from java.util.Map.size. Returns the number of key-value mappings in this map. If the map contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of key-value mappings in this map Annotations @Override

public int size()

Implements java.util.Map.size.

Doc from java.util.Map.size.

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of key-value mappings in this map

Annotations

@Override

writeReplace	back to summary
pack-priv Object writeReplace() Overrides com.google.common.collect.ImmutableMap.IteratorBasedImmutableMap.writeReplace. Doc from com.google.common.collect.ImmutableMap.writeReplace. Returns a serializable form of this object. Non-public subclasses should not override this method. Publicly-accessible subclasses must override this method and should return a subclass of SerializedForm whose readResolve() method returns objects of the subclass type. Annotations @Override @J2ktIncompatible

writeReplace

back to summary

pack-priv Object writeReplace()

Overrides com.google.common.collect.ImmutableMap.IteratorBasedImmutableMap.writeReplace.

Doc from com.google.common.collect.ImmutableMap.writeReplace.

Returns a serializable form of this object. Non-public subclasses should not override this method. Publicly-accessible subclasses must override this method and should return a subclass of SerializedForm whose readResolve() method returns objects of the subclass type.

Annotations

@Override
@J2ktIncompatible

pack-priv final Class ImmutableEnumMap<K extends Enum<K>, V>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ImmutableEnumMap.EnumSerializedForm<K extends Enum<K>, V>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
pack-priv final EnumMap<K, V>	delegate
private static final long	serialVersionUID