com.carrotsearch.hppc

Interface ShortIntMap

All Superinterfaces:

java.lang.Iterable<ShortIntCursor>, ShortIntAssociativeContainer

All Known Implementing Classes:

ShortIntOpenHashMap

@Generated(date="2015-06-17T12:23:42+0000",
           value="HPPC generated from: ShortIntMap.java")
public interface ShortIntMap
extends ShortIntAssociativeContainer

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

Method Summary

Modifier and Type	Method and Description
int	addTo(short key, int additionValue) An equivalent of calling
boolean	equals(java.lang.Object obj) Compares the specified object with this set for equality.
int	get(short key)
int	getOrDefault(short key, int defaultValue)
int	hashCode()
int	put(short key, int value) Place a given key and value in the container.
int	putAll(java.lang.Iterable<? extends ShortIntCursor> iterable) Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
int	putAll(ShortIntAssociativeContainer container) Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.
int	putOrAdd(short key, int putValue, int additionValue) Trove-inspired API method.
int	remove(short key) Remove all values at the given key.

Methods inherited from interface com.carrotsearch.hppc.ShortIntAssociativeContainer

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

put

int put(short key,
        int 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

int addTo(short key,
          int 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

int putOrAdd(short key,
             int putValue,
             int additionValue)

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

  if (containsKey(key))
  {
      int v = (int) (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

int get(short 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

int getOrDefault(short key,
                 int 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(ShortIntAssociativeContainer 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 ShortIntCursor> 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

int remove(short 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 ShortIntMap 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.