MapToObjectKeyCharMapAdapter (Primitive Collections for Java API v1.2)

Overview

Package

Class

Tree

Deprecated

Index

Help

PCJ API
Version 1.2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

bak.pcj.adapter
Class MapToObjectKeyCharMapAdapter

java.lang.Object
  bak.pcj.map.AbstractObjectKeyCharMap
      bak.pcj.adapter.MapToObjectKeyCharMapAdapter

All Implemented Interfaces:: ObjectKeyCharMap

public class MapToObjectKeyCharMapAdapter
extends AbstractObjectKeyCharMap
implements ObjectKeyCharMap

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

      MapToObjectKeyCharMapAdapter s;
      ...
      assert s.validate();

or by letting the adapter throw an exception on illegal values:

      MapToObjectKeyCharMapAdapter 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 Character`	`lastValue` The value corresponding to the last key found by containsKey().
`protected Map`	`map` The underlying map.

Constructor Summary
`MapToObjectKeyCharMapAdapter(Map map)` Creates a new adaption to a map from object values to char values.
`MapToObjectKeyCharMapAdapter(Map map, boolean validate)` Creates a new adaption to a map from object values to char 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(char value)` Indicates whether this map contains a mapping to a specified value.
`ObjectKeyCharMapIterator`	`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.
`char`	`get(Object key)` Maps a specified key to a value.
`Set`	`keySet()` Returns a set view of the keys of this map.
`char`	`lget()` Returns the last value corresponding to a positive result from `containsKey(Object)`.
`char`	`put(Object key, char value)` Adds a mapping from a specified key to a specified value to this map.
`char`	`remove(Object key)` Removes the mapping from a specified key from this map.
`int`	`size()` Returns the size of this map.
`char`	`tget(Object key)` Maps a specified key to a value.
`boolean`	`validate()` Indicates whether the underlying map is valid for this adapter.
`CharCollection`	`values()` Returns a collection view of the values in this map.

Methods inherited from class bak.pcj.map.AbstractObjectKeyCharMap

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.ObjectKeyCharMap

equals, hashCode, isEmpty, putAll, trimToSize

Field Detail

map

protected Map map

The underlying map.

lastValue

protected Character lastValue

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

Constructor Detail

MapToObjectKeyCharMapAdapter

public MapToObjectKeyCharMapAdapter(Map map)

Creates a new adaption to a map from object values to char values.
Parameters:: map - the underlying map. This map must consist of values of class Character. Otherwise a ClassCastException will be thrown by some methods.
Throws:: NullPointerException - if map is null.

MapToObjectKeyCharMapAdapter

public MapToObjectKeyCharMapAdapter(Map map,
                                    boolean validate)

Creates a new adaption to a map from object values to char values. The map to adapt is optionally validated.
Parameters:: map - the underlying map. This map must consist of values of class Character. 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 Character.

Method Detail