org.jfree.util
Class HashNMap
- Cloneable, Serializable
extends java.lang.Object
implements Serializable, Cloneable
The HashNMap can be used to store multiple values by a single key value. The
values stored can be retrieved using a direct query or by creating an
enumeration over the stored elements.
boolean | add(Object key, Object val) - Adds a new key/value pair into this map.
|
void | clear() - Clears all keys and values of this map.
|
Object | clone() - Creates a deep copy of this HashNMap.
|
boolean | contains(Object value) - Tests whether this map contains the given key or value.
|
boolean | containsKey(Object key) - Tests whether this map contains the given key.
|
boolean | containsValue(Object value) - Tests whether this map contains the given value.
|
boolean | containsValue(Object key, Object value) - Tests whether this map contains the given value.
|
protected List | createList() - Returns a new empty list.
|
Object | get(Object key, int n) - Retrieves the n-th value registered for an key or null if there was no
such key in the list.
|
Iterator | getAll(Object key) - Returns an iterator over all elements registered to the given key.
|
Object | getFirst(Object key) - Retrieves the first value registered for an key or null if there was no
such key in the list.
|
int | getValueCount(Object key) - Returns the number of elements registered with the given key.
|
Set | keySet() - Returns all registered keys as set.
|
Iterator | keys() - Returns all registered keys as an enumeration.
|
boolean | put(Object key, Object val) - Inserts a new key/value pair into the map.
|
boolean | remove(Object key, Object value) - Removes the key/value pair from the map.
|
void | removeAll(Object key) - Removes all elements for the given key.
|
Object[] | toArray(Object key) - Returns the contents for the given key as object array.
|
Object[] | toArray(Object key, Object[] data) - Returns the contents for the given key as object array.
|
HashNMap
public HashNMap()
Default constructor.
add
public boolean add(Object key,
Object val)
Adds a new key/value pair into this map. If the key is not yet in the
map, it gets added to the map and the call is equal to
put(Object,Object).
key
- the key.val
- the value.
- true, if the value has been added, false otherwise
clear
public void clear()
Clears all keys and values of this map.
clone
public Object clone()
throws CloneNotSupportedException
Creates a deep copy of this HashNMap.
contains
public boolean contains(Object value)
Tests whether this map contains the given key or value.
- true if the key or value is contained in the map
containsKey
public boolean containsKey(Object key)
Tests whether this map contains the given key.
- true if the key is contained in the map
containsValue
public boolean containsValue(Object value)
Tests whether this map contains the given value.
- true if the value is registered in the map for an key.
containsValue
public boolean containsValue(Object key,
Object value)
Tests whether this map contains the given value.
key
- the key under which to find the valuevalue
- the value.
- true if the value is registered in the map for an key.
createList
protected List createList()
Returns a new empty list.
get
public Object get(Object key,
int n)
Retrieves the n-th value registered for an key or null if there was no
such key in the list. An index out of bounds exception is thrown if
there are less than n elements registered to this key.
key
- the key.n
- the index.
getAll
public Iterator getAll(Object key)
Returns an iterator over all elements registered to the given key.
getFirst
public Object getFirst(Object key)
Retrieves the first value registered for an key or null if there was no
such key in the list.
getValueCount
public int getValueCount(Object key)
Returns the number of elements registered with the given key.
- the number of element for this key, or 0 if there are no elements
registered.
keySet
public Set keySet()
Returns all registered keys as set.
keys
public Iterator keys()
Returns all registered keys as an enumeration.
- an enumeration of the keys.
put
public boolean put(Object key,
Object val)
Inserts a new key/value pair into the map. If such a pair already
exists, it gets replaced with the given values.
key
- the key.val
- the value.
remove
public boolean remove(Object key,
Object value)
Removes the key/value pair from the map. If the removed entry was the
last entry for this key, the key gets also removed.
key
- the key.value
- the value.
- true, if removing the element was successfull, false otherwise.
removeAll
public void removeAll(Object key)
Removes all elements for the given key.
toArray
public Object[] toArray(Object key)
Returns the contents for the given key as object array. If there were
no objects registered with that key, an empty object array is returned.
toArray
public Object[] toArray(Object key,
Object[] data)
Returns the contents for the given key as object array. If there were
no objects registered with that key, an empty object array is returned.
key
- the key.data
- the object array to receive the contents.