com.jogamp.common.util

Class ArrayHashMap<K,V>

java.lang.Object

com.jogamp.common.util.ArrayHashMap<K,V>

All Implemented Interfaces:

Cloneable, Map<K,V>

public class ArrayHashMap<K,V>
extends Object
implements Cloneable, Map<K,V>

HashMap implementation backed by an ArrayList to preserve order of values. Implementation properties are:

• Unique elements utilizing Object.hashCode() for O(1) operations, see below.
• Java 1.5 compatible

O(1) operations:

• put new key-value-pair(s)
• test for containment
• trying to remove non existent elements

O(n) operations:

• put existing key-value-pair(s)
• removing existing elements

For thread safety, the application shall decorate access to instances via RecursiveLock.

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INITIAL_CAPACITY The default initial capacity: 16
static float	DEFAULT_LOAD_FACTOR Default load factor: 0.75f

Constructor Summary

Constructors

Constructor and Description
ArrayHashMap(ArrayHashMap<K,V> o)
ArrayHashMap(boolean supportNullValue, int initialCapacity, float loadFactor)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
Object	clone() Implementation uses ArrayHashMap(ArrayHashMap).
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object arrayHashMap)
V	get(Object key)
ArrayList<V>	getData() Returns this object ordered ArrayList.
HashMap<K,V>	getMap() Returns this object hash map.
int	hashCode()
boolean	isEmpty()
Set<K>	keySet()
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> m)
V	remove(Object key)
int	size()
boolean	supportsNullValue() Returns true for default behavior, i.e.
ArrayList<V>	toArrayList()
String	toString()
Collection<V>	values()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOAD_FACTOR

public static final float DEFAULT_LOAD_FACTOR

Default load factor: 0.75f

See Also:

Constant Field Values

DEFAULT_INITIAL_CAPACITY

public static final int DEFAULT_INITIAL_CAPACITY

The default initial capacity: 16

See Also:

Constant Field Values

Constructor Detail

ArrayHashMap

public ArrayHashMap(boolean supportNullValue,
            int initialCapacity,
            float loadFactor)

Parameters:

supportNullValue - Use true for default behavior, i.e. null can be a valid value. Use false if null is not a valid value, here put(Object, Object) and remove(Object) will be optimized.

initialCapacity - use DEFAULT_INITIAL_CAPACITY for default

loadFactor - use DEFAULT_LOAD_FACTOR for default

See Also:

supportsNullValue()

ArrayHashMap

public ArrayHashMap(ArrayHashMap<K,V> o)

Method Detail

supportsNullValue

public final boolean supportsNullValue()

Returns true for default behavior, i.e. null can be a valid value.

Returns false if null is not a valid value, here put(Object, Object) and remove(Object) are optimized operations.

See Also:

ArrayHashMap(boolean, int, float)

clone

public final Object clone()

Implementation uses ArrayHashMap(ArrayHashMap).

Overrides:

clone in class Object

Returns:

a shallow copy of this ArrayHashMap, elements are not copied.

getData

public final ArrayList<V> getData()

Returns this object ordered ArrayList. Use w/ care, it's not a copy.

See Also:

toArrayList()

toArrayList

public final ArrayList<V> toArrayList()

Returns:

a shallow copy of this ArrayHashMap's ArrayList, elements are not copied.

See Also:

getData()

getMap

public final HashMap<K,V> getMap()

Returns this object hash map. Use w/ care, it's not a copy.

toString

public final String toString()

Overrides:

toString in class Object

clear

public final void clear()

Specified by:

clear in interface Map<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

values

public Collection<V> values()

See getData() and toArrayList().

Specified by:

values in interface Map<K,V>

See Also:

getData(), toArrayList()

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

get

public final V get(Object key)

Specified by:

get in interface Map<K,V>

put

public final V put(K key,
    V value)
            throws NullPointerException

This is an O(1) operation, in case the key does not exist, otherwise O(n).

Specified by:

put in interface Map<K,V>

Throws:

NullPointerException - if value is null but supportsNullValue() == false

putAll

public void putAll(Map<? extends K,? extends V> m)

Specified by:

putAll in interface Map<K,V>

remove

public final V remove(Object key)

This is an O(1) operation, in case the key does not exist, otherwise O(n).

Specified by:

remove in interface Map<K,V>

containsKey

public final boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

equals

public final boolean equals(Object arrayHashMap)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

hashCode

public final int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

size

public final int size()

Specified by:

size in interface Map<K,V>