ImmutableOpenMap (Elasticsearch: Core 2.3.5 API)

java.lang.Object
- org.elasticsearch.common.collect.ImmutableOpenMap<KType,VType>

All Implemented Interfaces:

Iterable<com.carrotsearch.hppc.cursors.ObjectObjectCursor<KType,VType>>
```
public final class ImmutableOpenMap<KType,VType>
extends Object
implements Iterable<com.carrotsearch.hppc.cursors.ObjectObjectCursor<KType,VType>>
```
An immutable map implementation based on open hash map.
Can be constructed using a builder(), or using builder(ImmutableOpenMap) (which is an optimized option to copy over existing content and modify it).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableOpenMap.Builder<KType,VType>

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <KType,VType> ImmutableOpenMap.Builder<KType,VType>`	`builder()`
`static <KType,VType> ImmutableOpenMap.Builder<KType,VType>`	`builder(ImmutableOpenMap<KType,VType> map)`
`static <KType,VType> ImmutableOpenMap.Builder<KType,VType>`	`builder(int size)`
`boolean`	`containsKey(KType key)` Returns `true` if this container has an association to a value for the given key.
`static <KType,VType> ImmutableOpenMap<KType,VType>`	`copyOf(com.carrotsearch.hppc.ObjectObjectMap<KType,VType> map)`
`boolean`	`equals(Object o)`
`VType`	`get(KType key)`
`VType`	`getOrDefault(KType key, VType defaultValue)`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`Iterator<com.carrotsearch.hppc.cursors.ObjectObjectCursor<KType,VType>>`	`iterator()` Returns a cursor over the entries (key-value pairs) in this map.
`com.carrotsearch.hppc.ObjectLookupContainer<KType>`	`keys()` Returns a specialized view of the keys of this associated container.
`com.google.common.collect.UnmodifiableIterator<KType>`	`keysIt()` Returns a direct iterator over the keys.
`static <KType,VType> ImmutableOpenMap<KType,VType>`	`of()`
`int`	`size()`
`String`	`toString()`
`com.carrotsearch.hppc.ObjectContainer<VType>`	`values()`
`com.google.common.collect.UnmodifiableIterator<VType>`	`valuesIt()` Returns a direct iterator over the keys.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - get
```
public VType get(KType key)
```
    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(KType 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(KType key)
```
    Returns true if this container has an association to a value for the given key.
  - size
```
public int size()
```
    Returns:
    
    Returns the current size (number of assigned keys) in the container.
  - isEmpty
```
public boolean isEmpty()
```
    Returns:
    
    Return true if this hash map contains no assigned keys.
  - iterator
```
public Iterator<com.carrotsearch.hppc.cursors.ObjectObjectCursor<KType,VType>> iterator()
```
    Returns a cursor over the entries (key-value pairs) in this map. The iterator is implemented as a cursor and it returns the same cursor instance on every call to Iterator.next(). To read the current key and value use the cursor's public fields. An example is shown below.
```
 for (IntShortCursor c : intShortMap)
 {
     System.out.println("index=" + c.index
       + " key=" + c.key
       + " value=" + c.value);
 }
 
```
    The index field inside the cursor gives the internal index inside the container's implementation. The interpretation of this index depends on to the container.
    Specified by:
    
    iterator in interface Iterable<com.carrotsearch.hppc.cursors.ObjectObjectCursor<KType,VType>>
  - keys
```
public com.carrotsearch.hppc.ObjectLookupContainer<KType> keys()
```
    Returns a specialized view of the keys of this associated container. The view additionally implements ObjectLookupContainer.
  - keysIt
```
public com.google.common.collect.UnmodifiableIterator<KType> keysIt()
```
    Returns a direct iterator over the keys.
  - values
```
public com.carrotsearch.hppc.ObjectContainer<VType> values()
```
    Returns:
    
    Returns a container with all values stored in this map.
  - valuesIt
```
public com.google.common.collect.UnmodifiableIterator<VType> valuesIt()
```
    Returns a direct iterator over the keys.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - of
```
public static <KType,VType> ImmutableOpenMap<KType,VType> of()
```
  - copyOf
```
public static <KType,VType> ImmutableOpenMap<KType,VType> copyOf(com.carrotsearch.hppc.ObjectObjectMap<KType,VType> map)
```
    Returns:
    
    An immutable copy of the given map
  - 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(ImmutableOpenMap<KType,VType> map)
```

Class ImmutableOpenMap<KType,VType>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

get

getOrDefault

containsKey

size

isEmpty

iterator

keys

keysIt

values

valuesIt

toString

equals

hashCode

of

copyOf

builder

builder

builder