|
PCJ API Version 1.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object bak.pcj.map.AbstractObjectKeyBooleanMap bak.pcj.adapter.MapToObjectKeyBooleanMapAdapter
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 valuesEither way, validation must be invoked directly by the client code.
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 |
protected Map map
protected Boolean lastValue
Constructor Detail |
public MapToObjectKeyBooleanMapAdapter(Map map)
map
- the underlying map. This map must
consist of
values of class
Boolean
. Otherwise a
ClassCastException
will be thrown by some methods.
NullPointerException
- if map is null.public MapToObjectKeyBooleanMapAdapter(Map map, boolean validate)
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.
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 |
public void clear()
ObjectKeyBooleanMap
clear
in interface ObjectKeyBooleanMap
clear
in class AbstractObjectKeyBooleanMap
public boolean containsKey(Object key)
ObjectKeyBooleanMap
lget()
will return the corresponding value.
containsKey
in interface ObjectKeyBooleanMap
containsKey
in class AbstractObjectKeyBooleanMap
public boolean containsValue(boolean value)
ObjectKeyBooleanMap
containsValue
in interface ObjectKeyBooleanMap
containsValue
in class AbstractObjectKeyBooleanMap
public ObjectKeyBooleanMapIterator entries()
ObjectKeyBooleanMap
entries
in interface ObjectKeyBooleanMap
public boolean get(Object key)
ObjectKeyBooleanMap
get
in interface ObjectKeyBooleanMap
get
in class AbstractObjectKeyBooleanMap
public Set keySet()
ObjectKeyBooleanMap
keySet
in interface ObjectKeyBooleanMap
public boolean lget()
ObjectKeyBooleanMap
containsKey(Object)
. This is useful
for checking checking the existence of a mapping while
avoiding two lookups on the same key.
lget
in interface ObjectKeyBooleanMap
containsKey(Object)
.ObjectKeyBooleanMap.get(Object)
,
ObjectKeyBooleanMap.tget(Object)
,
ObjectKeyBooleanMap.containsKey(Object)
public boolean put(Object key, boolean value)
ObjectKeyBooleanMap
put
in interface ObjectKeyBooleanMap
key
- the key of the mapping to add to this map.value
- the value of the mapping to add to this map.
MapDefaults
public boolean remove(Object key)
ObjectKeyBooleanMap
remove
in interface ObjectKeyBooleanMap
remove
in class AbstractObjectKeyBooleanMap
public int size()
ObjectKeyBooleanMap
size
in interface ObjectKeyBooleanMap
size
in class AbstractObjectKeyBooleanMap
public BooleanCollection values()
ObjectKeyBooleanMap
values
in interface ObjectKeyBooleanMap
public boolean tget(Object key)
ObjectKeyBooleanMap
tget
in interface ObjectKeyBooleanMap
tget
in class AbstractObjectKeyBooleanMap
public boolean validate()
Boolean
values.
public void evalidate()
Boolean
values.
IllegalStateException
- if the underlying map is invalid.
|
PCJ API Version 1.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |