Class OrderedHashMap<K,V>

java.lang.Object

org.hsqldb.lib.HashMap<K,V>

org.hsqldb.lib.OrderedHashMap<K,V>

All Implemented Interfaces:

Map<K,V>

public class OrderedHashMap<K,V>
extends HashMap<K,V>

A Map which maintains the insertion order of the key/value pairs and allows access by index. Iterators return the keys or values in the index order.

This class does not store null keys.

Since:

1.7.2

Author:

Fred Toussi (fredt@users dot sourceforge.net)

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACCESS_MAX
static final Object[]	emptyObjectArray

Constructor Summary

Constructors

Constructor	Description
OrderedHashMap()
OrderedHashMap(int initialCapacity)

Method Summary

Modifier and Type	Method	Description
boolean	add(K key, V value)
void	clear()	Clear the map completely.
org.hsqldb.map.BaseHashMap	clone()
V	get(int index)	Same as getValueAt(index).
int	getIndex(K key)
K	getKeyAt(int index)	Returns the key stored in the entry at index position.
V	getValueAt(int index)	Returns the value stored in the entry at index position.
boolean	insert(int index, K key, V value)
boolean	isEmpty()
V	remove(Object key)
void	removeEntry(int index)
boolean	set(int index, K key, V value)
boolean	setKeyAt(int index, K key)
V	setValueAt(int index, V value)
int	size()

Methods inherited from class HashMap

containsKey, containsValue, entrySet, get, keySet, keysToArray, put, putAll, remove, values, valuesToArray

Methods inherited from class Object

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

Methods inherited from interface Map

clear, isEmpty, size

Field Details

ACCESS_MAX

public static final int ACCESS_MAX

See Also:

• Constant Field Values

emptyObjectArray

public static final Object[] emptyObjectArray

Constructor Details

OrderedHashMap

public OrderedHashMap()

OrderedHashMap

public OrderedHashMap(int initialCapacity)
               throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Details

getKeyAt

public K getKeyAt(int index)
           throws IndexOutOfBoundsException

Returns the key stored in the entry at index position.

Parameters:

index - the index of the entry

Returns:

the value stored in the entry

Throws:

IndexOutOfBoundsException - for invalid argument

getValueAt

public V getValueAt(int index)
             throws IndexOutOfBoundsException

Returns the value stored in the entry at index position.

Parameters:

index - the index of the entry

Returns:

the value stored in the entry

Throws:

IndexOutOfBoundsException - for invalid argument

get

public V get(int index)
      throws IndexOutOfBoundsException

Same as getValueAt(index).

Parameters:

index - the index of the entry

Returns:

the value stored in the entry

Throws:

IndexOutOfBoundsException - for invalid argument

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class HashMap<K,V>

removeEntry

public void removeEntry(int index)
                 throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

add

public boolean add(K key,
 V value)

setValueAt

public V setValueAt(int index,
 V value)
             throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

insert

public boolean insert(int index,
 K key,
 V value)
               throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

set

public boolean set(int index,
 K key,
 V value)
            throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

setKeyAt

public boolean setKeyAt(int index,
 K key)
                 throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

getIndex

public int getIndex(K key)

clear

public void clear()

Clear the map completely.

size

public int size()

isEmpty

public boolean isEmpty()

clone

public org.hsqldb.map.BaseHashMap clone()