org.danilopianini.lang

Class ExactHashObjectMap<V>

java.lang.Object

gnu.trove.impl.hash.THash

gnu.trove.impl.hash.TPrimitiveHash

gnu.trove.impl.hash.TIntHash

gnu.trove.map.hash.TIntObjectHashMap<V>

org.danilopianini.lang.ExactHashObjectMap<V>

Type Parameters:

V -

All Implemented Interfaces:

TIntObjectMap<V>, Externalizable, Serializable

public class ExactHashObjectMap<V>
extends TIntObjectHashMap<V>

A map which stores objects using hash codes for indexing. Note: if two different objects have the same hashCode, this map WILL NOT WORK PROPERLY. You must be sure that for the stored object the generated hash codes are univocal.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class gnu.trove.map.hash.TIntObjectHashMap

TIntObjectHashMap.ValueView

Field Summary

Fields inherited from class gnu.trove.map.hash.TIntObjectHashMap

_values, no_entry_key

Fields inherited from class gnu.trove.impl.hash.TIntHash

_set, consumeFreeSlot, no_entry_value

Fields inherited from class gnu.trove.impl.hash.TPrimitiveHash

_states, FREE, FULL, REMOVED

Fields inherited from class gnu.trove.impl.hash.THash

_autoCompactionFactor, _autoCompactRemovesRemaining, _autoCompactTemporaryDisable, _free, _loadFactor, _maxSize, _size, DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR

Constructor Summary

Constructors

Constructor and Description
ExactHashObjectMap() Builds a new, emtpy map.
ExactHashObjectMap(int expectedSize) Builds a new map, which will not resize until the number of stored objects will be less or equal to expectedSize.
ExactHashObjectMap(TIntObjectMap<? extends V> map) Builds a new map containing all the elements of the passed map.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(Object key) Returns true if this map contains a mapping for the specified key.
V	get(Object key) Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
V	put(Object key, V value) Associates the specified value with the specified key in this map (optional operation).
V	remove(Object key) Removes the mapping for a key from this map if it is present (optional operation).

Methods inherited from class gnu.trove.map.hash.TIntObjectHashMap

clear, containsKey, containsValue, equals, forEachEntry, forEachKey, forEachValue, get, getNoEntryKey, hashCode, iterator, keys, keys, keySet, put, putAll, putAll, putIfAbsent, readExternal, rehash, remove, removeAt, retainEntries, setUp, toString, transformValues, valueCollection, values, values, writeExternal

Methods inherited from class gnu.trove.impl.hash.TIntHash

contains, forEach, getNoEntryValue, index, insertKey

Methods inherited from class gnu.trove.impl.hash.TPrimitiveHash

capacity

Methods inherited from class gnu.trove.impl.hash.THash

calculateGrownCapacity, compact, computeMaxSize, computeNextAutoCompactionAmount, ensureCapacity, getAutoCompactionFactor, isEmpty, postInsertHook, reenableAutoCompaction, setAutoCompactionFactor, size, tempDisableAutoCompaction, trimToSize

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface gnu.trove.map.TIntObjectMap

isEmpty, size

Constructor Detail

ExactHashObjectMap

public ExactHashObjectMap()

Builds a new, emtpy map.

ExactHashObjectMap

public ExactHashObjectMap(TIntObjectMap<? extends V> map)

Builds a new map containing all the elements of the passed map.

Parameters:

map - the map to copy

ExactHashObjectMap

public ExactHashObjectMap(int expectedSize)

Builds a new map, which will not resize until the number of stored objects will be less or equal to expectedSize.

Parameters:

expectedSize - the expected size

Method Detail

containsKey

public boolean containsKey(Object key)

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that key.equals(k). (There can be at most one such mapping.)

Parameters:

key - key whose presence in this map is to be tested

Returns:

true if this map contains a mapping for the specified key

get

public V get(Object key)

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters:

key - the key whose associated value is to be returned

Returns:

the int value to which the specified key is mapped, or null if this map contains no mapping for the key

put

public V put(Object key,
             V value)

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters:

key - key with which the specified value is to be associated

value - an int value value to be associated with the specified key

Returns:

the previous value associated with key, or no_entry_value if there was no mapping for key. (A no_entry_value return can also indicate that the map previously associated null with key, if the implementation supports null values.)

See Also:

TIntObjectHashMap.getNoEntryKey()

remove

public V remove(Object key)

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that key.equals(k), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Parameters:

key - key whose mapping is to be removed from the map

Returns:

the previous int value associated with key, or null if there was no mapping for key.