net.sourceforge.pain.db
Class DbIntKeyMap

java.lang.Object
  net.sourceforge.pain.db.DbCollection
      net.sourceforge.pain.db.DbAbstractMap
          net.sourceforge.pain.db.DbIntKeyMap

All Implemented Interfaces:

java.util.Map

public final class DbIntKeyMap

extends net.sourceforge.pain.db.DbAbstractMap

implements java.util.Map

Hash table based persistent implementation of the Map interface.
This map allows only Integer objects instances as keys and DbObject as values.

Nested Class Summary

static class

DbCollection.ReadOnlyIterator

Nested classes inherited from class java.util.Map

java.util.Map.Entry

Method Summary

void	clear() Removes all mappings from this map (optional operation).
boolean	containsKey(int key)
boolean	containsKey(java.lang.Object key) Returns true if this map contains a mapping for the specified key.
boolean	containsValue(java.lang.Object value) Returns true if this map maps one or more keys to the specified value.
java.lang.Object	createBackupImage()
java.util.Set	entrySet() Returns a set view of the mappings contained in this map.
java.lang.Object	get(int key)
java.lang.Object	get(java.lang.Object key) Returns the value to which this map maps the specified key.
boolean	isEmpty() Returns true if this map contains no key-value mappings.
java.util.Set	keySet() Returns a set view of the keys contained in this map.
java.util.Iterator	keysIterator()
java.lang.Object	put(int key, java.lang.Object o)
java.lang.Object	put(java.lang.Object key, java.lang.Object o) Associates the specified value with the specified key in this map (optional operation).
void	putAll(java.util.Map m) Copies all of the mappings from the specified map to this map (optional operation).
java.lang.Object	remove(int key)
java.lang.Object	remove(java.lang.Object key) Removes the mapping for this key from this map if it is present (optional operation).
int	size() Returns the number of key-value mappings in this map.
java.util.Collection	values() Returns a collection view of the values contained in this map.
java.util.Iterator	valuesIterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Method Detail

createBackupImage

public java.lang.Object createBackupImage()

valuesIterator

public java.util.Iterator valuesIterator()

keysIterator

public java.util.Iterator keysIterator()

get

public java.lang.Object get(java.lang.Object key)

Description copied from interface: java.util.Map

Returns the value to which this map maps the specified key. Returns 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's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

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.)

Specified by:

get in interface java.util.Map

Parameters:

key - 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:

Map.containsKey(Object)

get

public java.lang.Object get(int key)

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object o)

Description copied from interface: java.util.Map

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for this 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.))

Specified by:

put in interface java.util.Map

Parameters:

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

o - 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 map previously associated null with the specified key, if the implementation supports null values.

put

public java.lang.Object put(int key,
                            java.lang.Object o)

remove

public java.lang.Object remove(java.lang.Object key)

Description copied from interface: java.util.Map

Removes the mapping for this 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==null ? k==null : key.equals(k)), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which the map previously associated the key, or null if the map contained no mapping for this key. (A null return can also indicate that the map previously associated null with the specified key if the implementation supports null values.) The map will not contain a mapping for the specified key once the call returns.

Specified by:

remove in interface java.util.Map

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.

remove

public java.lang.Object remove(int key)

size

public int size()

Description copied from interface: java.util.Map

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface java.util.Map

Returns:

the number of key-value mappings in this map.

clear

public void clear()

Description copied from interface: java.util.Map

Removes all mappings from this map (optional operation).

Specified by:

clear in interface java.util.Map

isEmpty

public boolean isEmpty()

Description copied from interface: java.util.Map

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

Specified by:

isEmpty in interface java.util.Map

Returns:

true if this map contains no key-value mappings.

containsKey

public boolean containsKey(java.lang.Object key)

Description copied from interface: java.util.Map

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

Specified by:

containsKey in interface java.util.Map

Parameters:

key - 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(int key)

containsValue

public boolean containsValue(java.lang.Object value)

Description copied from interface: java.util.Map

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that (value==null ? v==null : value.equals(v)). This operation will probably require time linear in the map size for most implementations of the Map interface.

Specified by:

containsValue in interface java.util.Map

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.

values

public java.util.Collection values()

Description copied from interface: java.util.Map

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. If the map is modified while an iteration over the collection is in progress, the results of the iteration are undefined. 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:

values in interface java.util.Map

Returns:

a collection view of the values contained in this map.

putAll

public void putAll(java.util.Map m)

Description copied from interface: java.util.Map

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is unspecified if the specified map is modified while the operation is in progress.

Specified by:

putAll in interface java.util.Map

Parameters:

m - Mappings to be stored in this map.

entrySet

public java.util.Set entrySet()

Description copied from interface: java.util.Map

Returns a set view of the mappings contained in this map. Each element in the returned set is a Map.Entry. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress, the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Specified by:

entrySet in interface java.util.Map

Returns:

a set view of the mappings contained in this map.

keySet

public java.util.Set keySet()

Description copied from interface: java.util.Map

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. If the map is modified while an iteration over the set is in progress, the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the 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 java.util.Map

Returns:

a set view of the keys contained in this map.