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

All Implemented Interfaces:

ObjectObjectAssociativeContainer<KType,VType>, ObjectObjectMap<KType,VType>, Iterable<ObjectObjectCursor<KType,VType>>

Enclosing class:

ImmutableOpenMap<KType,VType>
```
public static class ImmutableOpenMap.Builder<KType,VType>
extends Object
implements ObjectObjectMap<KType,VType>
```

Constructor Summary

Constructors
Constructor Description

Builder()

Builder(int size)

Builder(ImmutableOpenMap<KType,VType> map)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ImmutableOpenMap<KType,VType>`	`build()`	Builds a new instance of the
`<K,V> ImmutableOpenMap.Builder<K,V>`	`cast()`
`void`	`clear()`	Clear all keys and values in the container.
`boolean`	`containsKey(KType key)`	Returns `true` if this container has an association to a value for the given key.
`<T extends ObjectObjectProcedure<? super KType,? super VType>> T`	`forEach(T procedure)`	Applies a given procedure to all keys-value pairs in this container.
`ImmutableOpenMap.Builder<KType,VType>`	`fPut(KType key, VType value)`	A put operation that can be used in the fluent pattern.
`ImmutableOpenMap.Builder<KType,VType>`	`fRemove(KType key)`	Remove that can be used in the fluent pattern.
`VType`	`get(KType key)`
`VType`	`getOrDefault(KType kType, VType vType)`
`boolean`	`indexExists(int index)`
`VType`	`indexGet(int index)`	Returns the value associated with an existing key.
`void`	`indexInsert(int index, KType key, VType value)`	Inserts a key-value pair for a key that is not present in the map.
`int`	`indexOf(KType key)`	Returns a logical "index" of a given key that can be used to speed up follow-up value setters or getters in certain scenarios (conditional logic).
`VType`	`indexReplace(int index, VType newValue)`	Replaces the value associated with an existing key and returns any previous value stored for that key.
`boolean`	`isEmpty()`
`Iterator<ObjectObjectCursor<KType,VType>>`	`iterator()`	Returns a cursor over the entries (key-value pairs) in this map.
`ObjectCollection<KType>`	`keys()`	Returns a collection of keys of this container.
`VType`	`put(KType key, VType value)`	Place a given key and value in the container.
`int`	`putAll(ObjectObjectAssociativeContainer<? extends KType,? extends VType> container)`	Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.
`int`	`putAll(Iterable<? extends ObjectObjectCursor<? extends KType,? extends VType>> iterable)`	Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
`ImmutableOpenMap.Builder<KType,VType>`	`putAll(Map<KType,VType> map)`	Puts all the entries in the map to the builder.
`void`	`release()`	Removes all elements from the collection and additionally releases any internal buffers.
`VType`	`remove(KType key)`	Remove all values at the given key.
`int`	`removeAll(ObjectContainer<? super KType> container)`	Removes all keys (and associated values) present in a given container.
`int`	`removeAll(ObjectObjectPredicate<? super KType,? super VType> predicate)`	Removes all keys (and associated values) for which the predicate returns `true`.
`int`	`removeAll(ObjectPredicate<? super KType> predicate)`	Removes all keys (and associated values) for which the predicate returns `true`.
`int`	`size()`
`ObjectContainer<VType>`	`values()`	Returns a container view of all values present in this container.
`String`	`visualizeKeyDistribution(int characters)`	Visually depict the distribution of keys.

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

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

Methods inherited from interface com.carrotsearch.hppc.ObjectObjectMap
equals, hashCode

- Constructor Detail
  - Builder
```
public Builder()
```
  - Builder
```
public Builder(int size)
```
  - Builder
```
public Builder(ImmutableOpenMap<KType,VType> map)
```
- Method Detail
  - build
```
public ImmutableOpenMap<KType,VType> build()
```
    Builds a new instance of the
  - putAll
```
public ImmutableOpenMap.Builder<KType,VType> putAll(Map<KType,VType> map)
```
    Puts all the entries in the map to the builder.
  - fPut
```
public ImmutableOpenMap.Builder<KType,VType> fPut(KType key,
                                                        VType value)
```
    A put operation that can be used in the fluent pattern.
  - put
```
public VType put(KType key,
                 VType value)
```
    Description copied from interface: ObjectObjectMap
    
    Place a given key and value in the container.
    
    Specified by:
    
    put in interface ObjectObjectMap<KType,VType>
    
    Returns:
    
    The value previously stored under the given key in the map is returned.
  - get
```
public VType get(KType key)
```
    Specified by:
    
    get in interface ObjectObjectMap<KType,VType>
    
    Returns:
    
    Returns the value associated with the given key or the default value for the value type, if the key is not associated with any value. For numeric value types, this default value is 0, for object types it is null.
  - getOrDefault
```
public VType getOrDefault(KType kType,
                          VType vType)
```
    Specified by:
    
    getOrDefault in interface ObjectObjectMap<KType,VType>
    
    Returns:
    
    Returns the value associated with the given key or the provided default value if the key is not associated with any value.
  - putAll
```
public int putAll(ObjectObjectAssociativeContainer<? extends KType,? extends VType> container)
```
    Description copied from interface: ObjectObjectMap
    
    Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.
    
    Specified by:
    
    putAll in interface ObjectObjectMap<KType,VType>
    
    Returns:
    
    Returns the number of keys added to the map as a result of this call (not previously present in the map). Values of existing keys are overwritten.
  - putAll
```
public int putAll(Iterable<? extends ObjectObjectCursor<? extends KType,? extends VType>> iterable)
```
    Description copied from interface: ObjectObjectMap
    
    Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
    
    Specified by:
    
    putAll in interface ObjectObjectMap<KType,VType>
    
    Returns:
    
    Returns the number of keys added to the map as a result of this call (not previously present in the map). Values of existing keys are overwritten.
  - fRemove
```
public ImmutableOpenMap.Builder<KType,VType> fRemove(KType key)
```
    Remove that can be used in the fluent pattern.
  - remove
```
public VType remove(KType key)
```
    Description copied from interface: ObjectObjectMap
    
    Remove all values at the given key. The default value for the key type is returned if the value does not exist in the map.
    
    Specified by:
    
    remove in interface ObjectObjectMap<KType,VType>
  - iterator
```
public Iterator<ObjectObjectCursor<KType,VType>> iterator()
```
    Description copied from interface: ObjectObjectAssociativeContainer
    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<KType>
    
    Specified by:
    
    iterator in interface ObjectObjectAssociativeContainer<KType,VType>
  - containsKey
```
public boolean containsKey(KType key)
```
    Description copied from interface: ObjectObjectAssociativeContainer
    
    Returns true if this container has an association to a value for the given key.
    
    Specified by:
    
    containsKey in interface ObjectObjectAssociativeContainer<KType,VType>
  - size
```
public int size()
```
    Specified by:
    
    size in interface ObjectObjectAssociativeContainer<KType,VType>
    
    Returns:
    
    Returns the current size (number of assigned keys) in the container.
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface ObjectObjectAssociativeContainer<KType,VType>
    
    Returns:
    
    Return true if this hash map contains no assigned keys.
  - removeAll
```
public int removeAll(ObjectContainer<? super KType> container)
```
    Description copied from interface: ObjectObjectAssociativeContainer
    Removes all keys (and associated values) present in a given container. An alias to:
    keys().removeAll(container)
    but with no additional overhead.
    Specified by:
    
    removeAll in interface ObjectObjectAssociativeContainer<KType,VType>
    
    Returns:
    
    Returns the number of elements actually removed as a result of this call.
  - removeAll
```
public int removeAll(ObjectPredicate<? super KType> predicate)
```
    Description copied from interface: ObjectObjectAssociativeContainer
    
    Removes all keys (and associated values) for which the predicate returns true.
    
    Specified by:
    
    removeAll in interface ObjectObjectAssociativeContainer<KType,VType>
    
    Returns:
    
    Returns the number of elements actually removed as a result of this call.
  - forEach
```
public <T extends ObjectObjectProcedure<? super KType,? super VType>> T forEach(T procedure)
```
    Description copied from interface: ObjectObjectAssociativeContainer
    
    Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass of ObjectObjectProcedure. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example.
    
    Specified by:
    
    forEach in interface ObjectObjectAssociativeContainer<KType,VType>
  - clear
```
public void clear()
```
    Description copied from interface: ObjectObjectMap
    
    Clear all keys and values in the container.
    
    Specified by:
    
    clear in interface ObjectObjectMap<KType,VType>
    
    See Also:
    
    ObjectObjectMap.release()
  - keys
```
public ObjectCollection<KType> keys()
```
    Description copied from interface: ObjectObjectAssociativeContainer
    
    Returns a collection of keys of this container. The returned collection is a view over the key set and any modifications (if allowed) introduced to the collection will propagate to the associative container immediately.
    
    Specified by:
    
    keys in interface ObjectObjectAssociativeContainer<KType,VType>
  - values
```
public ObjectContainer<VType> values()
```
    Description copied from interface: ObjectObjectAssociativeContainer
    
    Returns a container view of all values present in this container. The returned collection is a view over the key set and any modifications (if allowed) introduced to the collection will propagate to the associative container immediately.
    
    Specified by:
    
    values in interface ObjectObjectAssociativeContainer<KType,VType>
  - cast
```
public <K,V> ImmutableOpenMap.Builder<K,V> cast()
```
  - removeAll
```
public int removeAll(ObjectObjectPredicate<? super KType,? super VType> predicate)
```
    Description copied from interface: ObjectObjectAssociativeContainer
    
    Removes all keys (and associated values) for which the predicate returns true.
    
    Specified by:
    
    removeAll in interface ObjectObjectAssociativeContainer<KType,VType>
    
    Returns:
    
    Returns the number of elements actually removed as a result of this call.
  - forEach
```
public <T extends ObjectObjectPredicate<? super KType,? super VType>> T forEach(T predicate)
```
    Description copied from interface: ObjectObjectAssociativeContainer
    
    Applies a given predicate to all keys-value pairs in this container. Returns the argument (any subclass of ObjectObjectPredicate. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example. The iteration is continued as long as the predicate returns true.
    
    Specified by:
    
    forEach in interface ObjectObjectAssociativeContainer<KType,VType>
  - indexOf
```
public int indexOf(KType key)
```
    Description copied from interface: ObjectObjectMap
    
    Returns a logical "index" of a given key that can be used to speed up follow-up value setters or getters in certain scenarios (conditional logic). The semantics of "indexes" are not strictly defined. Indexes may (and typically won't be) contiguous. The index is valid only between map modifications (it will not be affected by read-only operations like iteration or value retrievals).
    
    Specified by:
    
    indexOf in interface ObjectObjectMap<KType,VType>
    
    Parameters:
    
    key - The key to locate in the map.
    
    Returns:
    
    A non-negative value of the logical "index" of the key in the map or a negative value if the key did not exist.
    
    See Also:
    
    ObjectObjectMap.indexExists(int), ObjectObjectMap.indexGet(int), ObjectObjectMap.indexInsert(int, KType, VType), ObjectObjectMap.indexReplace(int, VType)
  - indexExists
```
public boolean indexExists(int index)
```
    Specified by:
    
    indexExists in interface ObjectObjectMap<KType,VType>
    
    Parameters:
    
    index - The index of a given key, as returned from ObjectObjectMap.indexOf(KType).
    
    Returns:
    
    Returns true if the index corresponds to an existing key or false otherwise. This is equivalent to checking whether the index is a positive value (existing keys) or a negative value (non-existing keys).
    
    See Also:
    
    ObjectObjectMap.indexOf(KType)
  - indexGet
```
public VType indexGet(int index)
```
    Description copied from interface: ObjectObjectMap
    
    Returns the value associated with an existing key.
    
    Specified by:
    
    indexGet in interface ObjectObjectMap<KType,VType>
    
    Parameters:
    
    index - The index of an existing key.
    
    Returns:
    
    Returns the value currently associated with the key.
    
    See Also:
    
    ObjectObjectMap.indexOf(KType)
  - indexReplace
```
public VType indexReplace(int index,
                          VType newValue)
```
    Description copied from interface: ObjectObjectMap
    
    Replaces the value associated with an existing key and returns any previous value stored for that key.
    
    Specified by:
    
    indexReplace in interface ObjectObjectMap<KType,VType>
    
    Parameters:
    
    index - The index of an existing key.
    
    Returns:
    
    Returns the previous value associated with the key.
    
    See Also:
    
    ObjectObjectMap.indexOf(KType)
  - indexInsert
```
public void indexInsert(int index,
                        KType key,
                        VType value)
```
    Description copied from interface: ObjectObjectMap
    
    Inserts a key-value pair for a key that is not present in the map. This method may help in avoiding double recalculation of the key's hash.
    
    Specified by:
    
    indexInsert in interface ObjectObjectMap<KType,VType>
    
    Parameters:
    
    index - The index of a previously non-existing key, as returned from ObjectObjectMap.indexOf(KType).
    
    See Also:
    
    ObjectObjectMap.indexOf(KType)
  - release
```
public void release()
```
    Description copied from interface: ObjectObjectMap
    
    Removes all elements from the collection and additionally releases any internal buffers. Typically, if the object is to be reused, a simple ObjectObjectMap.clear() should be a better alternative since it'll avoid reallocation.
    
    Specified by:
    
    release in interface ObjectObjectMap<KType,VType>
    
    See Also:
    
    ObjectObjectMap.clear()
  - visualizeKeyDistribution
```
public String visualizeKeyDistribution(int characters)
```
    Description copied from interface: ObjectObjectMap
    
    Visually depict the distribution of keys.
    
    Specified by:
    
    visualizeKeyDistribution in interface ObjectObjectMap<KType,VType>
    
    Parameters:
    
    characters - The number of characters to "squeeze" the entire buffer into.
    
    Returns:
    
    Returns a sequence of characters where '.' depicts an empty fragment of the internal buffer and 'X' depicts full or nearly full capacity within the buffer's range and anything between 1 and 9 is between.

Constructor	Description
`Builder()`
`Builder(int size)`
`Builder(ImmutableOpenMap<KType,VType> map)`

Class ImmutableOpenMap.Builder<KType,​VType>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Methods inherited from interface com.carrotsearch.hppc.ObjectObjectMap

Constructor Detail

Builder

Builder

Builder

Method Detail

build

putAll

fPut

put

get

getOrDefault

putAll

putAll

fRemove

remove

iterator

containsKey

size

isEmpty

removeAll

removeAll

forEach

clear

keys

values

cast

removeAll

forEach

indexOf

indexExists

indexGet

indexReplace

indexInsert

release

visualizeKeyDistribution

Class ImmutableOpenMap.Builder<KType,VType>