PCJ API
Version 1.2

bak.pcj.map
Class AbstractIntKeyMap

java.lang.Object
  extended bybak.pcj.map.AbstractIntKeyMap
All Implemented Interfaces:
IntKeyMap
Direct Known Subclasses:
IntKeyChainedHashMap, IntKeyOpenHashMap, MapToIntKeyMapAdapter

public abstract class AbstractIntKeyMap
extends Object
implements IntKeyMap

This class represents an abstract base for implementing maps from int values to objects. All operations that can be implemented using iterators are implemented as such. In most cases, this is hardly an efficient solution, and at least some of those methods should be overridden by sub-classes.

Since:
1.0

Constructor Summary
protected AbstractIntKeyMap()
          Default constructor to be invoked by sub-classes.
 
Method Summary
 void clear()
          Clears this map.
 boolean containsKey(int key)
          Indicates whether this map contains a mapping from a specified key.
 boolean containsValue(Object value)
          Indicates whether this map contains a mapping to a specified value.
 boolean equals(Object obj)
          Indicates whether this map is equal to some object.
 Object get(int key)
          Maps a specified key to a value.
 int hashCode()
          Returns a hash code value for this map.
 boolean isEmpty()
          Indicates whether this map is empty.
 void putAll(IntKeyMap map)
          Adds all mappings from a specified map to this map.
 Object remove(int key)
          Removes the mapping from a specified key from this map.
 int size()
          Returns the size of this map.
 String toString()
          Returns a string representation of this map.
 void trimToSize()
          Does nothing.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface bak.pcj.map.IntKeyMap
entries, keySet, put, values
 

Constructor Detail

AbstractIntKeyMap

protected AbstractIntKeyMap()
Default constructor to be invoked by sub-classes.

Method Detail

clear

public void clear()
Description copied from interface: IntKeyMap
Clears this map.

Specified by:
clear in interface IntKeyMap

remove

public Object remove(int key)
Description copied from interface: IntKeyMap
Removes the mapping from a specified key from this map.

Specified by:
remove in interface IntKeyMap
Parameters:
key - the key whose mapping to remove from this map.
Returns:
the old value (which can be null) if a mapping from the specified key already existed in this map; returns null otherwise.

putAll

public void putAll(IntKeyMap map)
Description copied from interface: IntKeyMap
Adds all mappings from a specified map to this map. Any existing mappings whose keys collide with a new mapping is overwritten by the new mapping.

Specified by:
putAll in interface IntKeyMap
Parameters:
map - the map whose mappings to add to this map.

containsKey

public boolean containsKey(int key)
Description copied from interface: IntKeyMap
Indicates whether this map contains a mapping from a specified key.

Specified by:
containsKey in interface IntKeyMap
Parameters:
key - the key to test for.
Returns:
true if this map contains a mapping from the specified key; returns false otherwise.

get

public Object get(int key)
Description copied from interface: IntKeyMap
Maps a specified key to a value.

Specified by:
get in interface IntKeyMap
Parameters:
key - the key to map to a value.
Returns:
the value that the specified key maps to; returns null, if no mapping exists for the specified key.

containsValue

public boolean containsValue(Object value)
Description copied from interface: IntKeyMap
Indicates whether this map contains a mapping to a specified value.

Specified by:
containsValue in interface IntKeyMap
Parameters:
value - the value to test for.
Returns:
true if this map contains at least one mapping to the specified value; returns false otherwise.

equals

public boolean equals(Object obj)
Description copied from interface: IntKeyMap
Indicates whether this map is equal to some object.

Specified by:
equals in interface IntKeyMap

hashCode

public int hashCode()
Description copied from interface: IntKeyMap
Returns a hash code value for this map.

Specified by:
hashCode in interface IntKeyMap

isEmpty

public boolean isEmpty()
Description copied from interface: IntKeyMap
Indicates whether this map is empty.

Specified by:
isEmpty in interface IntKeyMap
Returns:
true if this map is empty; returns false otherwise.

size

public int size()
Description copied from interface: IntKeyMap
Returns the size of this map. The size is defined as the number of mappings from keys to values.

Specified by:
size in interface IntKeyMap
Returns:
the size of this map.

toString

public String toString()
Returns a string representation of this map.

Returns:
a string representation of this map.

trimToSize

public void trimToSize()
Does nothing. Sub-classes may provide an implementation to minimize memory usage, but this is not required since many implementations will always have minimal memory usage.


PCJ API
Version 1.2

Report a bug or request a feature.
Further information on the development and latest release of PCJ can be found at the project homepage.

Primitive Collections for Java is released under the GNU Lesser General Public License.
Copyright © 2002, 2003 Søren Bak. All Rights Reserved.

Hosted by SourceForge.net
SourceForge.net Logo