Package org.elasticsearch.common.collect

Class ImmutableOpenIntMap.Builder<VType>

java.lang.Object

org.elasticsearch.common.collect.ImmutableOpenIntMap.Builder<VType>

All Implemented Interfaces:

IntObjectAssociativeContainer<VType>, IntObjectMap<VType>, Iterable<IntObjectCursor<VType>>

Enclosing class:

ImmutableOpenIntMap<VType>

public static class ImmutableOpenIntMap.Builder<VType>
extends Object
implements IntObjectMap<VType>

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(int size)
Builder(ImmutableOpenIntMap<VType> map)

Method Summary

Modifier and Type	Method	Description
ImmutableOpenIntMap<VType>	build()	Builds a new instance of the
void	clear()	Clear all keys and values in the container.
boolean	containsKey(int key)	Returns true if this container has an association to a value for the given key.
<T extends IntObjectProcedure<? super VType>> T	forEach(T procedure)	Applies a given procedure to all keys-value pairs in this container.
ImmutableOpenIntMap.Builder<VType>	fPut(int key, VType value)	A put operation that can be used in the fluent pattern.
ImmutableOpenIntMap.Builder<VType>	fRemove(int key)	Remove that can be used in the fluent pattern.
VType	get(int key)
VType	getOrDefault(int kType, VType vType)
boolean	indexExists(int index)
VType	indexGet(int index)	Returns the value associated with an existing key.
void	indexInsert(int index, int key, VType value)	Inserts a key-value pair for a key that is not present in the map.
int	indexOf(int 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<IntObjectCursor<VType>>	iterator()	Returns a cursor over the entries (key-value pairs) in this map.
IntCollection	keys()	Returns a collection of keys of this container.
VType	put(int key, VType value)	Place a given key and value in the container.
int	putAll(IntObjectAssociativeContainer<? 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 IntObjectCursor<? extends VType>> iterable)	Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
ImmutableOpenIntMap.Builder<VType>	putAll(Map<Integer,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(int key)	Remove all values at the given key.
int	removeAll(IntContainer container)	Removes all keys (and associated values) present in a given container.
int	removeAll(IntObjectPredicate<? super VType> predicate)	Removes all keys (and associated values) for which the predicate returns true.
int	removeAll(IntPredicate 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 com.carrotsearch.hppc.IntObjectMap

equals, hashCode

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Builder

public Builder()

Builder

public Builder(int size)

Builder

public Builder(ImmutableOpenIntMap<VType> map)

Method Detail

build

public ImmutableOpenIntMap<VType> build()

Builds a new instance of the

putAll

public ImmutableOpenIntMap.Builder<VType> putAll(Map<Integer,VType> map)

Puts all the entries in the map to the builder.

fPut

public ImmutableOpenIntMap.Builder<VType> fPut(int key,
                                               VType value)

A put operation that can be used in the fluent pattern.

put

public VType put(int key,
                 VType value)

Description copied from interface: IntObjectMap

Place a given key and value in the container.

Specified by:

put in interface IntObjectMap<VType>

Returns:

The value previously stored under the given key in the map is returned.

get

public VType get(int key)

Specified by:

get in interface IntObjectMap<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(int kType,
                          VType vType)

Specified by:

getOrDefault in interface IntObjectMap<VType>

Returns:

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

fRemove

public ImmutableOpenIntMap.Builder<VType> fRemove(int key)

Remove that can be used in the fluent pattern.

remove

public VType remove(int key)

Description copied from interface: IntObjectMap

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 IntObjectMap<VType>

iterator

public Iterator<IntObjectCursor<VType>> iterator()

Description copied from interface: IntObjectAssociativeContainer

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 IntObjectAssociativeContainer<VType>

Specified by:

iterator in interface Iterable<VType>

containsKey

public boolean containsKey(int key)

Description copied from interface: IntObjectAssociativeContainer

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

Specified by:

containsKey in interface IntObjectAssociativeContainer<VType>

size

public int size()

Specified by:

size in interface IntObjectAssociativeContainer<VType>

Returns:

Returns the current size (number of assigned keys) in the container.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IntObjectAssociativeContainer<VType>

Returns:

Return true if this hash map contains no assigned keys.

clear

public void clear()

Description copied from interface: IntObjectMap

Clear all keys and values in the container.

Specified by:

clear in interface IntObjectMap<VType>

See Also:

IntObjectMap.release()

putAll

public int putAll(IntObjectAssociativeContainer<? extends VType> container)

Description copied from interface: IntObjectMap

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 IntObjectMap<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 IntObjectCursor<? extends VType>> iterable)

Description copied from interface: IntObjectMap

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 IntObjectMap<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.

removeAll

public int removeAll(IntContainer container)

Description copied from interface: IntObjectAssociativeContainer

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 IntObjectAssociativeContainer<VType>

Returns:

Returns the number of elements actually removed as a result of this call.

removeAll

public int removeAll(IntPredicate predicate)

Description copied from interface: IntObjectAssociativeContainer

Removes all keys (and associated values) for which the predicate returns true.

Specified by:

removeAll in interface IntObjectAssociativeContainer<VType>

Returns:

Returns the number of elements actually removed as a result of this call.

forEach

public <T extends IntObjectProcedure<? super VType>> T forEach(T procedure)

Description copied from interface: IntObjectAssociativeContainer

Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass of IntObjectProcedure. 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 IntObjectAssociativeContainer<VType>

keys

public IntCollection keys()

Description copied from interface: IntObjectAssociativeContainer

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 IntObjectAssociativeContainer<VType>

values

public ObjectContainer<VType> values()

Description copied from interface: IntObjectAssociativeContainer

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 IntObjectAssociativeContainer<VType>

removeAll

public int removeAll(IntObjectPredicate<? super VType> predicate)

Description copied from interface: IntObjectAssociativeContainer

Removes all keys (and associated values) for which the predicate returns true.

Specified by:

removeAll in interface IntObjectAssociativeContainer<VType>

Returns:

Returns the number of elements actually removed as a result of this call.

forEach

public <T extends IntObjectPredicate<? super VType>> T forEach(T predicate)

Description copied from interface: IntObjectAssociativeContainer

Applies a given predicate to all keys-value pairs in this container. Returns the argument (any subclass of IntObjectPredicate. 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 IntObjectAssociativeContainer<VType>

indexOf

public int indexOf(int key)

Description copied from interface: IntObjectMap

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 IntObjectMap<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:

IntObjectMap.indexExists(int), IntObjectMap.indexGet(int), IntObjectMap.indexInsert(int, int, VType), IntObjectMap.indexReplace(int, VType)

indexExists

public boolean indexExists(int index)

Specified by:

indexExists in interface IntObjectMap<VType>

Parameters:

index - The index of a given key, as returned from IntObjectMap.indexOf(int).

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:

IntObjectMap.indexOf(int)

indexGet

public VType indexGet(int index)

Description copied from interface: IntObjectMap

Returns the value associated with an existing key.

Specified by:

indexGet in interface IntObjectMap<VType>

Parameters:

index - The index of an existing key.

Returns:

Returns the value currently associated with the key.

See Also:

IntObjectMap.indexOf(int)

indexReplace

public VType indexReplace(int index,
                          VType newValue)

Description copied from interface: IntObjectMap

Replaces the value associated with an existing key and returns any previous value stored for that key.

Specified by:

indexReplace in interface IntObjectMap<VType>

Parameters:

index - The index of an existing key.

Returns:

Returns the previous value associated with the key.

See Also:

IntObjectMap.indexOf(int)

indexInsert

public void indexInsert(int index,
                        int key,
                        VType value)

Description copied from interface: IntObjectMap

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 IntObjectMap<VType>

Parameters:

index - The index of a previously non-existing key, as returned from IntObjectMap.indexOf(int).

See Also:

IntObjectMap.indexOf(int)

release

public void release()

Description copied from interface: IntObjectMap

Removes all elements from the collection and additionally releases any internal buffers. Typically, if the object is to be reused, a simple IntObjectMap.clear() should be a better alternative since it'll avoid reallocation.

Specified by:

release in interface IntObjectMap<VType>

See Also:

IntObjectMap.clear()

visualizeKeyDistribution

public String visualizeKeyDistribution(int characters)

Description copied from interface: IntObjectMap

Visually depict the distribution of keys.

Specified by:

visualizeKeyDistribution in interface IntObjectMap<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.