com.carrotsearch.hppcrt

Interface ObjectCharMap<KType>

All Superinterfaces:

java.lang.Iterable<ObjectCharCursor<KType>>, ObjectCharAssociativeContainer<KType>

All Known Implementing Classes:

ObjectCharHashMap, ObjectCharIdentityHashMap

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

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

Method Summary

Modifier and Type	Method and Description
char	addTo(KType key, char additionValue) An equivalent of calling putOrAdd(key, additionValue, additionValue);
void	clear() Clear all keys and values in the container.
char	get(KType key)
char	getDefaultValue() Returns the "default value" value used in containers methods returning "default value"
char	put(KType key, char value) Place a given key and value in the container.
int	putAll(java.lang.Iterable<? extends ObjectCharCursor<? extends KType>> iterable) Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
int	putAll(ObjectCharAssociativeContainer<? extends KType> container) Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.
boolean	putIfAbsent(KType key, char value) Trove-inspired API method.
char	putOrAdd(KType key, char putValue, char additionValue) If key exists, putValue is inserted into the map, otherwise any existing value is incremented by additionValue.
char	remove(KType key) Remove the (key, value) pair associated with the given key, and returns the assocaited value.
void	setDefaultValue(char defaultValue) Set the "default value" value to be used in containers methods returning "default value"

Methods inherited from interface com.carrotsearch.hppcrt.ObjectCharAssociativeContainer

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

put

char put(KType key,
         char 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(KType key,
                    char 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.

putOrAdd

char putOrAdd(KType key,
              char putValue,
              char additionValue)

If key exists, putValue is inserted into the map, otherwise any existing value is incremented by additionValue.

Parameters:

key - The key of the value to adjust.

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

incrementValue - The value to add to the existing value if key exists.

Returns:

Returns the current value associated with key (after changes).

addTo

char addTo(KType key,
           char additionValue)

An equivalent of calling

 putOrAdd(key, additionValue, additionValue);
 

Parameters:

key - The key of the value to adjust.

additionValue - The value to put or add to the existing value if key exists.

Returns:

Returns the current value associated with key (after changes).

get

char get(KType 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(ObjectCharAssociativeContainer<? extends KType> 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 ObjectCharCursor<? extends KType>> 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

char remove(KType 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

char getDefaultValue()

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

setDefaultValue

void setDefaultValue(char defaultValue)

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