com.carrotsearch.hppc
Interface ShortCharMap

All Superinterfaces:

java.lang.Iterable<ShortCharCursor>, ShortCharAssociativeContainer

All Known Implementing Classes:

ShortCharOpenHashMap

@Generated(date="2012-11-19T09:50:02+0100",
           value="HPPC generated from: ShortCharMap.java")
public interface ShortCharMap
extends ShortCharAssociativeContainer

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

Method Summary

boolean	equals(java.lang.Object obj) Compares the specified object with this set for equality.
char	get(short key)
int	hashCode()
char	put(short key, char value) Place a given key and value in the container.
int	putAll(java.lang.Iterable<? extends ShortCharCursor> iterable) Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
int	putAll(ShortCharAssociativeContainer container) Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.
char	remove(short key) Remove all values at the given key.

Methods inherited from interface com.carrotsearch.hppc.ShortCharAssociativeContainer

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

Method Detail

put

char put(short 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.

get

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

putAll

int putAll(ShortCharAssociativeContainer 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 ShortCharCursor> 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(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 ShortCharMap 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.