com.carrotsearch.hppc

Interface ObjectCharMap<KType>

All Superinterfaces:

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

All Known Implementing Classes:

ObjectCharOpenHashMap, ObjectCharOpenIdentityHashMap

@Generated(date="2015-06-17T12:23:42+0000",
           value="HPPC generated from: ObjectCharMap.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
boolean	equals(java.lang.Object obj) Compares the specified object with this set for equality.
char	get(KType key)
char	getOrDefault(KType key, char defaultValue)
int	hashCode()
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.
char	putOrAdd(KType key, char putValue, char additionValue) Trove-inspired API method.
char	remove(KType key) Remove all values at the given key.

Methods inherited from interface com.carrotsearch.hppc.ObjectCharAssociativeContainer

clear, containsKey, forEach, isEmpty, iterator, keys, 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:

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

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

putOrAdd

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

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

  if (containsKey(key))
  {
      char v = (char) (lget() + additionValue);
      lset(v);
      return v;
  }
  else
  {
     put(key, putValue);
     return putValue;
  }
 

Parameters:

key - The key of the value to adjust.

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

additionValue - The value to 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 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

char getOrDefault(KType key,
                  char defaultValue)

Returns:

Returns the value associated with the given key or the provided 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 all values at the given key. The default value for the key type is returned if the value does not exist in the map.

equals

boolean equals(java.lang.Object obj)

Compares the specified object with this set for equality. Returns true if and only if the specified object is also a ObjectCharMap and both objects contains exactly the same key-value pairs.

Overrides:

equals in class java.lang.Object

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code of elements stored in the map. The hash code is defined as a sum of hash codes of keys and values stored within the set). Because sum is commutative, this ensures that different order of elements in a set does not affect the hash code.