com.carrotsearch.hppcrt

Interface FloatObjectMap<VType>

All Superinterfaces:

FloatObjectAssociativeContainer<VType>, java.lang.Iterable<FloatObjectCursor<VType>>

All Known Implementing Classes:

FloatObjectHashMap

@Generated(date="2017-07-11T19:16:24+0200",
           value="KTypeVTypeMap.java")
public interface FloatObjectMap<VType>
extends FloatObjectAssociativeContainer<VType>

An associative container with unique binding from keys to a single value.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all keys and values in the container.
VType	get(float key)
VType	getDefaultValue() Returns the "default value" value used in containers methods returning "default value"
VType	put(float key, VType value) Place a given key and value in the container.
int	putAll(FloatObjectAssociativeContainer<? 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(java.lang.Iterable<? extends FloatObjectCursor<? extends VType>> iterable) Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
boolean	putIfAbsent(float key, VType value) Trove-inspired API method.
VType	remove(float key) Remove the (key, value) pair associated with the given key, and returns the assocaited value.
void	setDefaultValue(VType defaultValue) Set the "default value" value to be used in containers methods returning "default value"

Methods inherited from interface com.carrotsearch.hppcrt.FloatObjectAssociativeContainer

capacity, containsKey, forEach, forEach, isEmpty, iterator, keys, removeAll, removeAll, removeAll, size, values

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

put

VType put(float key,
          VType value)

Place a given key and value in the container.

Returns:

Returns the value previously stored under the given key, if an equal key is already in the map and replaces the existing value only with the argument value. If the given key was not already in the map, the given (key, value) pair is inserted in the map and the default value is returned.

putIfAbsent

boolean putIfAbsent(float key,
                    VType value)

Trove-inspired API method. An equivalent of the following code:

 if (!map.containsKey(key))
      map.put(key, value);
 

Parameters:

key - The key of the value to check.

value - The value to put if key does not exist.

Returns:

true if key did not exist and value was placed in the map.

get

VType get(float key)

Returns:

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

putAll

int putAll(FloatObjectAssociativeContainer<? extends VType> container)

Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.

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

int putAll(java.lang.Iterable<? extends FloatObjectCursor<? extends VType>> iterable)

Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.

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.

remove

VType remove(float key)

Remove the (key, value) pair associated with the given key, and returns the assocaited value. The default value is returned if the key did not exist in the map.

Parameters:

key -

clear

void clear()

Clear all keys and values in the container.

getDefaultValue

VType getDefaultValue()

Returns the "default value" value used in containers methods returning "default value"

setDefaultValue

void setDefaultValue(VType defaultValue)

Set the "default value" value to be used in containers methods returning "default value"