Module org.elasticsearch.server

Package org.elasticsearch.common.collect

Class ImmutableOpenMap<KType,VType>

java.lang.Object

java.util.AbstractMap<KType,VType>

org.elasticsearch.common.collect.ImmutableOpenMap<KType,VType>

All Implemented Interfaces:

Map<KType,VType>

public final class ImmutableOpenMap<KType,VType>
extends AbstractMap<KType,VType>

An immutable map implementation based on open hash map.

Can be constructed using a builder(), or using builder(Map) (which is an optimized option to copy over existing content and modify it).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableOpenMap.Builder<KType,VType>

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Method Summary

Modifier and Type	Method	Description
static <KType, VType> ImmutableOpenMap.Builder<KType,VType>	builder()
static <KType, VType> ImmutableOpenMap.Builder<KType,VType>	builder(int size)
static <KType, VType> ImmutableOpenMap.Builder<KType,VType>	builder(Map<KType,VType> map)
void	clear()
boolean	containsKey(Object key)	Returns true if this container has an association to a value for the given key.
boolean	containsValue(Object value)
Set<Map.Entry<KType,VType>>	entrySet()
boolean	equals(Object o)
void	forEach(BiConsumer<? super KType,? super VType> action)
VType	get(Object key)
VType	getOrDefault(Object key, VType defaultValue)
int	hashCode()
boolean	isEmpty()
Set<KType>	keySet()
static <KType, VType> ImmutableOpenMap<KType,VType>	of()
VType	put(KType key, VType value)
void	putAll(Map<? extends KType,? extends VType> m)
VType	remove(Object key)
int	size()
String	toString()
Collection<VType>	values()

Methods inherited from class java.util.AbstractMap

clone

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Details

get

public VType get(Object key)

Specified by:

get in interface Map<KType,VType>

Overrides:

get in class AbstractMap<KType,VType>

Returns:

Returns the value associated with the given key or the default value for the key type, if the key is not associated with any value.

Important note: For primitive type values, the value returned for a non-existing key may not be the default value of the primitive type (it may be any value previously assigned to that slot).

getOrDefault

public VType getOrDefault(Object key,
 VType defaultValue)

Returns:

Returns the value associated with the given key or the provided default value if the key is not associated with any value.

containsKey

public boolean containsKey(Object key)

Returns true if this container has an association to a value for the given key.

Specified by:

containsKey in interface Map<KType,VType>

Overrides:

containsKey in class AbstractMap<KType,VType>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<KType,VType>

Overrides:

containsValue in class AbstractMap<KType,VType>

put

public VType put(KType key,
 VType value)

Specified by:

put in interface Map<KType,VType>

Overrides:

put in class AbstractMap<KType,VType>

remove

public VType remove(Object key)

Specified by:

remove in interface Map<KType,VType>

Overrides:

remove in class AbstractMap<KType,VType>

putAll

public void putAll(Map<? extends KType,? extends VType> m)

Specified by:

putAll in interface Map<KType,VType>

Overrides:

putAll in class AbstractMap<KType,VType>

clear

public void clear()

Specified by:

clear in interface Map<KType,VType>

Overrides:

clear in class AbstractMap<KType,VType>

size

public int size()

Specified by:

size in interface Map<KType,VType>

Overrides:

size in class AbstractMap<KType,VType>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<KType,VType>

Overrides:

isEmpty in class AbstractMap<KType,VType>

entrySet

public Set<Map.Entry<KType,VType>> entrySet()

Specified by:

entrySet in interface Map<KType,VType>

Specified by:

entrySet in class AbstractMap<KType,VType>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<KType,VType>

Overrides:

equals in class AbstractMap<KType,VType>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<KType,VType>

Overrides:

hashCode in class AbstractMap<KType,VType>

keySet

public Set<KType> keySet()

Specified by:

keySet in interface Map<KType,VType>

Overrides:

keySet in class AbstractMap<KType,VType>

values

public Collection<VType> values()

Specified by:

values in interface Map<KType,VType>

Overrides:

values in class AbstractMap<KType,VType>

forEach

public void forEach(BiConsumer<? super KType,? super VType> action)

toString

public String toString()

Overrides:

toString in class AbstractMap<KType,VType>

of

public static <KType,
VType>
ImmutableOpenMap<KType,VType> of()

builder

public static <KType,
VType>
ImmutableOpenMap.Builder<KType,VType> builder()

builder

public static <KType,
VType>
ImmutableOpenMap.Builder<KType,VType> builder(int size)

builder

public static <KType,
VType>
ImmutableOpenMap.Builder<KType,VType> builder(Map<KType,VType> map)