PCJ API
Version 1.2

bak.pcj.adapter
Class MapToObjectKeyBooleanMapAdapter

java.lang.Object
  extended bybak.pcj.map.AbstractObjectKeyBooleanMap
      extended bybak.pcj.adapter.MapToObjectKeyBooleanMapAdapter
All Implemented Interfaces:
ObjectKeyBooleanMap

public class MapToObjectKeyBooleanMapAdapter
extends AbstractObjectKeyBooleanMap
implements ObjectKeyBooleanMap

This class represents adaptions of Java Collections Framework maps to primitive maps from object 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 values or 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:

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

Since:
1.1

Field Summary
protected  Boolean lastValue
          The value corresponding to the last key found by containsKey().
protected  Map map
          The underlying map.
 
Constructor Summary
MapToObjectKeyBooleanMapAdapter(Map map)
          Creates a new adaption to a map from object values to boolean values.
MapToObjectKeyBooleanMapAdapter(Map map, boolean validate)
          Creates a new adaption to a map from object values to boolean values.
 
Method Summary
 void clear()
          Clears this map.
 boolean containsKey(Object 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.
 ObjectKeyBooleanMapIterator 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(Object key)
          Maps a specified key to a value.
 Set keySet()
          Returns a set view of the keys of this map.
 boolean lget()
          Returns the last value corresponding to a positive result from containsKey(Object).
 boolean put(Object key, boolean value)
          Adds a mapping from a specified key to a specified value to this map.
 boolean remove(Object key)
          Removes the mapping from a specified key from this map.
 int size()
          Returns the size of this map.
 boolean tget(Object 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.AbstractObjectKeyBooleanMap
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.ObjectKeyBooleanMap
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

MapToObjectKeyBooleanMapAdapter

public MapToObjectKeyBooleanMapAdapter(Map map)
Creates a new adaption to a map from object values to boolean values.

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

MapToObjectKeyBooleanMapAdapter

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

Parameters:
map - the underlying map. This map must consist of 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 value, or a value that is not of class Boolean.
Method Detail

clear

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

Specified by:
clear in interface ObjectKeyBooleanMap
Overrides:
clear in class AbstractObjectKeyBooleanMap

containsKey

public boolean containsKey(Object key)
Description copied from interface: ObjectKeyBooleanMap
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 ObjectKeyBooleanMap
Overrides:
containsKey in class AbstractObjectKeyBooleanMap

containsValue

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

Specified by:
containsValue in interface ObjectKeyBooleanMap
Overrides:
containsValue in class AbstractObjectKeyBooleanMap

entries

public ObjectKeyBooleanMapIterator entries()
Description copied from interface: ObjectKeyBooleanMap
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 ObjectKeyBooleanMap
Returns:
an iterator over the entries of this map.

get

public boolean get(Object key)
Description copied from interface: ObjectKeyBooleanMap
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 ObjectKeyBooleanMap
Overrides:
get in class AbstractObjectKeyBooleanMap

keySet

public Set keySet()
Description copied from interface: ObjectKeyBooleanMap
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 ObjectKeyBooleanMap
Returns:
a set view of the keys of this map.

lget

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

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

put

public boolean put(Object key,
                   boolean value)
Description copied from interface: ObjectKeyBooleanMap
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 ObjectKeyBooleanMap
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(Object key)
Description copied from interface: ObjectKeyBooleanMap
Removes the mapping from a specified key from this map.

Specified by:
remove in interface ObjectKeyBooleanMap
Overrides:
remove in class AbstractObjectKeyBooleanMap

size

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

Specified by:
size in interface ObjectKeyBooleanMap
Overrides:
size in class AbstractObjectKeyBooleanMap

values

public BooleanCollection values()
Description copied from interface: ObjectKeyBooleanMap
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 ObjectKeyBooleanMap
Returns:
a collection view of the values in this map.

tget

public boolean tget(Object key)
Description copied from interface: ObjectKeyBooleanMap
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 ObjectKeyBooleanMap
Overrides:
tget in class AbstractObjectKeyBooleanMap

validate

public boolean validate()
Indicates whether the underlying map is valid for this adapter. For the underlying map to be valid it can contain no null 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 contain no null 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