MapToCharKeyMapAdapter (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 MapToCharKeyMapAdapter

java.lang.Object
  bak.pcj.map.AbstractCharKeyMap
      bak.pcj.adapter.MapToCharKeyMapAdapter

All Implemented Interfaces:: CharKeyMap

public class MapToCharKeyMapAdapter
extends AbstractCharKeyMap
implements CharKeyMap

This class represents adaptions of Java Collections Framework maps to primitive maps from char values to objects. 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 or keys of the wrong class. However, adapters are not fast failing in the case that the underlying map should contain illegal keys. To implement fast failure would require every operation to check every key of the underlying map before doing anything. Instead validation methods are provided. They can be called using the assertion facility in the client code:

      MapToCharKeyMapAdapter s;
      ...
      assert s.validate();

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

      MapToCharKeyMapAdapter 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 Map`	`map` The underlying map.

Constructor Summary
`MapToCharKeyMapAdapter(Map map)` Creates a new adaption to a map from char values to objects.
`MapToCharKeyMapAdapter(Map map, boolean validate)` Creates a new adaption to a map from char values to objects.

Method Summary
`void`	`clear()` Clears this map.
`boolean`	`containsKey(char key)` Indicates whether this map contains a mapping from a specified key.
`boolean`	`containsValue(Object value)` Indicates whether this map contains a mapping to a specified value.
`CharKeyMapIterator`	`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.
`Object`	`get(char key)` Maps a specified key to a value.
`CharSet`	`keySet()` Returns a set view of the keys of this map.
`Object`	`put(char key, Object value)` Adds a mapping from a specified key to a specified value to this map.
`Object`	`remove(char key)` Removes the mapping from a specified key from this map.
`int`	`size()` Returns the size of this map.
`boolean`	`validate()` Indicates whether the underlying map is valid for this adapter.
`Collection`	`values()` Returns a collection view of the values in this map.

Methods inherited from class bak.pcj.map.AbstractCharKeyMap

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

equals, hashCode, isEmpty, putAll

Field Detail

map

protected Map map

The underlying map.

Constructor Detail

MapToCharKeyMapAdapter

public MapToCharKeyMapAdapter(Map map)

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

MapToCharKeyMapAdapter

public MapToCharKeyMapAdapter(Map map,
                              boolean validate)

Creates a new adaption to a map from char values to objects. The map to adapt is optionally validated.
Parameters:: map - the underlying map. This map must consist of keys of class Character. Otherwise a ClassCastException will be thrown by some methods.; validate - indicates whether map should be checked for illegal keys.
Throws:: NullPointerException - if map is null.; IllegalStateException - if validate is true and map contains a null key or a key that is not of class Character.

Method Detail