PCJ API
Version 1.2

bak.pcj.adapter
Class MapToIntKeyBooleanMapAdapter

java.lang.Object
  extended bybak.pcj.map.AbstractIntKeyBooleanMap
      extended bybak.pcj.adapter.MapToIntKeyBooleanMapAdapter
All Implemented Interfaces:
IntKeyBooleanMap

public class MapToIntKeyBooleanMapAdapter
extends AbstractIntKeyBooleanMap
implements IntKeyBooleanMap

This class represents adaptions of Java Collections Framework maps to primitive maps from int values to boolean values. The adapter is implemented as a wrapper around the map. Thus, changes to the underlying map are reflected by this map and vice versa.

Adapters from JCF maps to primitive map will fail if the JCF collection contains null keys/values or keys/values of the wrong class. However, adapters are not fast failing in the case that the underlying map should contain illegal keys or values. To implement fast failure would require every operation to check every key and value of the underlying map before doing anything. Instead validation methods are provided. They can be called using the assertion facility in the client code:

      MapToIntKeyBooleanMapAdapter s;
      ...
      assert s.validate();
  
or by letting the adapter throw an exception on illegal values:
      MapToIntKeyBooleanMapAdapter s;
      ...
      s.evalidate();  // Throws an exception on illegal values
  
Either way, validation must be invoked directly by the client code.

Since:
1.0

Field Summary
protected  Boolean lastValue
          The value corresponding to the last key found by containsKey().
protected  Map map
          The underlying map.
 
Constructor Summary
MapToIntKeyBooleanMapAdapter(Map map)
          Creates a new adaption to a map from int values to boolean values.
MapToIntKeyBooleanMapAdapter(Map map, boolean validate)
          Creates a new adaption to a map from int values to boolean values.
 
Method Summary
 void clear()
          Clears this map.
 boolean containsKey(int key)
          Indicates whether this map contains a mapping from a specified key.
 boolean containsValue(boolean value)
          Indicates whether this map contains a mapping to a specified value.
 IntKeyBooleanMapIterator entries()
          Returns an iterator over the entries of this map.
 void evalidate()
          Validates the map underlying this adapter and throws an exception if it is invalid.
 boolean get(int key)
          Maps a specified key to a value.
 IntSet keySet()
          Returns a set view of the keys of this map.
 boolean lget()
          Returns the last value corresponding to a positive result from containsKey(int).
 boolean put(int key, boolean value)
          Adds a mapping from a specified key to a specified value to this map.
 boolean remove(int key)
          Removes the mapping from a specified key from this map.
 int size()
          Returns the size of this map.
 boolean tget(int key)
          Maps a specified key to a value.
 boolean validate()
          Indicates whether the underlying map is valid for this adapter.
 BooleanCollection values()
          Returns a collection view of the values in this map.
 
Methods inherited from class bak.pcj.map.AbstractIntKeyBooleanMap
equals, hashCode, isEmpty, putAll, toString, trimToSize
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface bak.pcj.map.IntKeyBooleanMap
equals, hashCode, isEmpty, putAll, trimToSize
 

Field Detail

map

protected Map map
The underlying map.


lastValue

protected Boolean lastValue
The value corresponding to the last key found by containsKey().

Constructor Detail

MapToIntKeyBooleanMapAdapter

public MapToIntKeyBooleanMapAdapter(Map map)
Creates a new adaption to a map from int values to boolean values.

Parameters:
map - the underlying map. This map must consist of keys of class Integer. values of class Boolean. Otherwise a ClassCastException will be thrown by some methods.
Throws:
NullPointerException - if map is null.

MapToIntKeyBooleanMapAdapter

public MapToIntKeyBooleanMapAdapter(Map map,
                                    boolean validate)
Creates a new adaption to a map from int values to boolean values. The map to adapt is optionally validated.

Parameters:
map - the underlying map. This map must consist of keys of class Integer. values of class Boolean. Otherwise a ClassCastException will be thrown by some methods.
validate - indicates whether map should be checked for illegal values.
Throws:
NullPointerException - if map is null.
IllegalStateException - if validate is true and map contains a null key/value, a key that is not of class Integer, or a value that is not of class Boolean.
Method Detail

clear

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

Specified by:
clear in interface IntKeyBooleanMap
Overrides:
clear in class AbstractIntKeyBooleanMap

containsKey

public boolean containsKey(int key)
Description copied from interface: IntKeyBooleanMap
Indicates whether this map contains a mapping from a specified key. If the key is contained in this map, a succeeding call to lget() will return the corresponding value.

Specified by:
containsKey in interface IntKeyBooleanMap
Overrides:
containsKey in class AbstractIntKeyBooleanMap

containsValue

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

Specified by:
containsValue in interface IntKeyBooleanMap
Overrides:
containsValue in class AbstractIntKeyBooleanMap

entries

public IntKeyBooleanMapIterator entries()
Description copied from interface: IntKeyBooleanMap
Returns an iterator over the entries of this map. It is possible to remove entries from this map using the iterator provided that the concrete map supports removal of entries.

Specified by:
entries in interface IntKeyBooleanMap
Returns:
an iterator over the entries of this map.

get

public boolean get(int key)
Description copied from interface: IntKeyBooleanMap
Maps a specified key to a value. Returns a default value as specified by the MapDefaults class if no mapping exists for the specified key.

Specified by:
get in interface IntKeyBooleanMap
Overrides:
get in class AbstractIntKeyBooleanMap

keySet

public IntSet keySet()
Description copied from interface: IntKeyBooleanMap
Returns a set view of the keys of this map. Removals from the returned set removes the corresponding entries in this map. Changes to the map are reflected in the set.

Specified by:
keySet in interface IntKeyBooleanMap
Returns:
a set view of the keys of this map.

lget

public boolean lget()
Description copied from interface: IntKeyBooleanMap
Returns the last value corresponding to a positive result from containsKey(int). This is useful for checking checking the existence of a mapping while avoiding two lookups on the same key.

Specified by:
lget in interface IntKeyBooleanMap
Returns:
the value corresponding to the key from the last invokation of containsKey(int).
See Also:
IntKeyBooleanMap.get(int), IntKeyBooleanMap.tget(int), IntKeyBooleanMap.containsKey(int)

put

public boolean put(int key,
                   boolean value)
Description copied from interface: IntKeyBooleanMap
Adds a mapping from a specified key to a specified value to this map. If a mapping already exists for the specified key it is overwritten by the new mapping.

Specified by:
put in interface IntKeyBooleanMap
Parameters:
key - the key of the mapping to add to this map.
value - the value of the mapping to add to this map.
Returns:
the old value if a mapping from the specified key already existed in this map; otherwise returns a default value as specified by the MapDefaults class.
See Also:
MapDefaults

remove

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

Specified by:
remove in interface IntKeyBooleanMap
Overrides:
remove in class AbstractIntKeyBooleanMap

size

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

Specified by:
size in interface IntKeyBooleanMap
Overrides:
size in class AbstractIntKeyBooleanMap

values

public BooleanCollection values()
Description copied from interface: IntKeyBooleanMap
Returns a collection view of the values in this map. The collection is not modifiable, but changes to the map are reflected in the collection.

Specified by:
values in interface IntKeyBooleanMap
Returns:
a collection view of the values in this map.

tget

public boolean tget(int key)
Description copied from interface: IntKeyBooleanMap
Maps a specified key to a value. This method should be used when the key is known to be in the map.

Specified by:
tget in interface IntKeyBooleanMap
Overrides:
tget in class AbstractIntKeyBooleanMap

validate

public boolean validate()
Indicates whether the underlying map is valid for this adapter. For the underlying map to be valid, it can only contain Integer keys, no null keys/values, and only Boolean values.

Returns:
true if the underlying map is valid; returns false otherwise.

evalidate

public void evalidate()
Validates the map underlying this adapter and throws an exception if it is invalid. For the underlying map to be valid, it can only contain Integer keys, no null keys/values, and only Boolean values.

Throws:
IllegalStateException - if the underlying map is invalid.

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