|
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.AbstractBooleanKeyFloatMap bak.pcj.adapter.MapToBooleanKeyFloatMapAdapter
This class represents adaptions of Java Collections Framework maps to primitive maps from boolean values to float 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:
MapToBooleanKeyFloatMapAdapter s; ... assert s.validate();or by letting the adapter throw an exception on illegal values:
MapToBooleanKeyFloatMapAdapter s; ... s.evalidate(); // Throws an exception on illegal valuesEither way, validation must be invoked directly by the client code.
Field Summary | |
protected Float |
lastValue
The value corresponding to the last key found by containsKey(). |
protected Map |
map
The underlying map. |
Constructor Summary | |
MapToBooleanKeyFloatMapAdapter(Map map)
Creates a new adaption to a map from boolean values to float values. |
|
MapToBooleanKeyFloatMapAdapter(Map map,
boolean validate)
Creates a new adaption to a map from boolean values to float values. |
Method Summary | |
void |
clear()
Clears this map. |
boolean |
containsKey(boolean key)
Indicates whether this map contains a mapping from a specified key. |
boolean |
containsValue(float value)
Indicates whether this map contains a mapping to a specified value. |
BooleanKeyFloatMapIterator |
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. |
float |
get(boolean key)
Maps a specified key to a value. |
BooleanSet |
keySet()
Returns a set view of the keys of this map. |
float |
lget()
Returns the last value corresponding to a positive result from containsKey(boolean) . |
float |
put(boolean key,
float value)
Adds a mapping from a specified key to a specified value to this map. |
float |
remove(boolean key)
Removes the mapping from a specified key from this map. |
int |
size()
Returns the size of this map. |
float |
tget(boolean key)
Maps a specified key to a value. |
boolean |
validate()
Indicates whether the underlying map is valid for this adapter. |
FloatCollection |
values()
Returns a collection view of the values in this map. |
Methods inherited from class bak.pcj.map.AbstractBooleanKeyFloatMap |
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.BooleanKeyFloatMap |
equals, hashCode, isEmpty, putAll, trimToSize |
Field Detail |
protected Map map
protected Float lastValue
Constructor Detail |
public MapToBooleanKeyFloatMapAdapter(Map map)
map
- the underlying map. This map must
consist of keys of class
Boolean
.
values of class
Float
. Otherwise a
ClassCastException
will be thrown by some methods.
NullPointerException
- if map is null.public MapToBooleanKeyFloatMapAdapter(Map map, boolean validate)
map
- the underlying map. This map must
consist of keys of class
Boolean
.
values of class
Float
. 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 key/value,
a key that is not of class
Boolean
,
or a value that is not of class
Float
.Method Detail |
public void clear()
BooleanKeyFloatMap
clear
in interface BooleanKeyFloatMap
clear
in class AbstractBooleanKeyFloatMap
public boolean containsKey(boolean key)
BooleanKeyFloatMap
lget()
will return the corresponding value.
containsKey
in interface BooleanKeyFloatMap
containsKey
in class AbstractBooleanKeyFloatMap
public boolean containsValue(float value)
BooleanKeyFloatMap
containsValue
in interface BooleanKeyFloatMap
containsValue
in class AbstractBooleanKeyFloatMap
public BooleanKeyFloatMapIterator entries()
BooleanKeyFloatMap
entries
in interface BooleanKeyFloatMap
public float get(boolean key)
BooleanKeyFloatMap
get
in interface BooleanKeyFloatMap
get
in class AbstractBooleanKeyFloatMap
public BooleanSet keySet()
BooleanKeyFloatMap
keySet
in interface BooleanKeyFloatMap
public float lget()
BooleanKeyFloatMap
containsKey(boolean)
. This is useful
for checking checking the existence of a mapping while
avoiding two lookups on the same key.
lget
in interface BooleanKeyFloatMap
containsKey(boolean)
.BooleanKeyFloatMap.get(boolean)
,
BooleanKeyFloatMap.tget(boolean)
,
BooleanKeyFloatMap.containsKey(boolean)
public float put(boolean key, float value)
BooleanKeyFloatMap
put
in interface BooleanKeyFloatMap
key
- the key of the mapping to add to this map.value
- the value of the mapping to add to this map.
MapDefaults
public float remove(boolean key)
BooleanKeyFloatMap
remove
in interface BooleanKeyFloatMap
remove
in class AbstractBooleanKeyFloatMap
public int size()
BooleanKeyFloatMap
size
in interface BooleanKeyFloatMap
size
in class AbstractBooleanKeyFloatMap
public FloatCollection values()
BooleanKeyFloatMap
values
in interface BooleanKeyFloatMap
public float tget(boolean key)
BooleanKeyFloatMap
tget
in interface BooleanKeyFloatMap
tget
in class AbstractBooleanKeyFloatMap
public boolean validate()
Boolean
keys, no null
keys/values, and only Float
values.
public void evalidate()
Boolean
keys, no null
keys/values, and only Float
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 |