com.revolsys.collection.map

Class IntHashMap<T>

java.lang.Object

com.revolsys.collection.map.IntHashMap<T>

All Implemented Interfaces:

Serializable, Cloneable, Map<Integer,T>

public class IntHashMap<T>
extends Object
implements Map<Integer,T>, Cloneable, Serializable

This is a int hashmap that has the exact same features and interface as a normal Map except that the key is directly an integer. So no hash is calculated or key object is stored.

Author:

jcompagner

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntHashMap.IntEntry<T>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
IntHashMap() Constructs an empty HashMap with the default initial capacity (16) and the default load factor (0.75).
IntHashMap(int initialCapacity) Constructs an empty HashMap with the specified initial capacity and the default load factor (0.75).
IntHashMap(int initialCapacity, float loadFactor) Constructs an empty HashMap with the specified initial capacity and load factor.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all mappings from this map.
Object	clone() Returns a shallow copy of this HashMap instance: the keys and values themselves are not cloned.
boolean	containsKey(int key) Returns true if this map contains a mapping for the specified key.
boolean	containsKey(Object obj)
boolean	containsValue(Object value) Returns true if this map maps one or more keys to the specified value.
Set<IntHashMap.IntEntry<T>>	entryIntSet()
Set<Map.Entry<Integer,T>>	entrySet() Returns a collection view of the mappings contained in this map.
T	get(int key) Returns the value to which the specified key is mapped in this identity hash map, or null if the map contains no mapping for this key.
T	get(Object obj)
boolean	isEmpty() Returns true if this map contains no key-value mappings.
Set<Integer>	keySet() Returns a set view of the keys contained in this map.
T	put(Integer key, T value)
void	putAll(IntHashMap<T> m) Copies all of the mappings from the specified map to this map These mappings will replace any mappings that this map had for any of the keys currently in the specified map.
void	putAll(Map<? extends Integer,? extends T> map)
T	putInt(int key, T value) Associates the specified value with the specified key in this map.
T	remove(int key) Removes the mapping for this key from this map if present.
T	remove(Object obj)
int	size() Returns the number of key-value mappings in this map.
Collection<T>	values() Returns a collection view of the values contained in this map.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

IntHashMap

public IntHashMap()

Constructs an empty HashMap with the default initial capacity (16) and the default load factor (0.75).

IntHashMap

public IntHashMap(int initialCapacity)

Constructs an empty HashMap with the specified initial capacity and the default load factor (0.75).

Parameters:

initialCapacity - the initial capacity.

Throws:

IllegalArgumentException - if the initial capacity is negative.

IntHashMap

public IntHashMap(int initialCapacity,
          float loadFactor)

Constructs an empty HashMap with the specified initial capacity and load factor.

Parameters:

initialCapacity - The initial capacity.

loadFactor - The load factor.

Throws:

IllegalArgumentException - if the initial capacity is negative or the load factor is nonpositive.

Method Detail

clear

public void clear()

Removes all mappings from this map.

Specified by:

clear in interface Map<Integer,T>

clone

public Object clone()
             throws CloneNotSupportedException

Returns a shallow copy of this HashMap instance: the keys and values themselves are not cloned.

Overrides:

clone in class Object

Returns:

a shallow copy of this map.

Throws:

CloneNotSupportedException

containsKey

public boolean containsKey(int key)

Returns true if this map contains a mapping for the specified key.

Parameters:

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

Returns:

true if this map contains a mapping for the specified key.

containsKey

public boolean containsKey(Object obj)

Specified by:

containsKey in interface Map<Integer,T>

containsValue

public boolean containsValue(Object value)

Returns true if this map maps one or more keys to the specified value.

Specified by:

containsValue in interface Map<Integer,T>

Parameters:

value - value whose presence in this map is to be tested.

Returns:

true if this map maps one or more keys to the specified value.

entryIntSet

public Set<IntHashMap.IntEntry<T>> entryIntSet()

entrySet

public Set<Map.Entry<Integer,T>> entrySet()

Returns a collection view of the mappings contained in this map. Each element in the returned collection is a Map.Entry. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

entrySet in interface Map<Integer,T>

Returns:

a collection view of the mappings contained in this map.

See Also:

Map.Entry

get

public T get(int key)

Returns the value to which the specified key is mapped in this identity hash map, or null if the map contains no mapping for this key. A return value of null does not necessarily indicate that the map contains no mapping for the key; it is also possible that the map explicitly maps the key to null. The containsKey method may be used to distinguish these two cases.

Parameters:

key - the key whose associated value is to be returned.

Returns:

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

See Also:

#put(int, Object)

get

public T get(Object obj)

Specified by:

get in interface Map<Integer,T>

isEmpty

public boolean isEmpty()

Returns true if this map contains no key-value mappings.

Specified by:

isEmpty in interface Map<Integer,T>

Returns:

true if this map contains no key-value mappings.

keySet

public Set<Integer> keySet()

Returns a set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. The set supports element removal, which removes the corresponding mapping from this map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

keySet in interface Map<Integer,T>

Returns:

a set view of the keys contained in this map.

put

public T put(Integer key,
    T value)

Specified by:

put in interface Map<Integer,T>

putAll

public void putAll(IntHashMap<T> m)

Copies all of the mappings from the specified map to this map These mappings will replace any mappings that this map had for any of the keys currently in the specified map.

Parameters:

m - mappings to be stored in this map.

Throws:

NullPointerException - if the specified map is null.

putAll

public void putAll(Map<? extends Integer,? extends T> map)

Specified by:

putAll in interface Map<Integer,T>

putInt

public T putInt(int key,
       T value)

Associates the specified value with the specified key in this map. If the map previously contained a mapping for this key, the old value is replaced.

Parameters:

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

value - value to be associated with the specified key.

Returns:

previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the HashMap previously associated null with the specified key.

remove

public T remove(int key)

Removes the mapping for this key from this map if present.

Parameters:

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

Returns:

previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key.

remove

public T remove(Object obj)

Specified by:

remove in interface Map<Integer,T>

size

public int size()

Returns the number of key-value mappings in this map.

Specified by:

size in interface Map<Integer,T>

Returns:

the number of key-value mappings in this map.

values

public Collection<T> values()

Returns a collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. The collection supports element removal, which removes the corresponding mapping from this map, via the Iterator.remove, Collection.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

values in interface Map<Integer,T>

Returns:

a collection view of the values contained in this map.