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

java.lang.Object
  bak.pcj.AbstractCharCollection
      bak.pcj.set.AbstractCharSet
          bak.pcj.adapter.SetToCharSetAdapter

All Implemented Interfaces:: CharCollection, CharSet

Direct Known Subclasses:: SortedSetToCharSortedSetAdapter

public class SetToCharSetAdapter
extends AbstractCharSet
implements CharSet

This class represents adaptions of Java Collections Framework sets to primitive sets of char values. The adapter is implemented as a wrapper around the set. Thus, changes to the underlying set are reflected by this set and vice versa.

Adapters from JCF collections to primitive collections 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 collection should contain illegal values. To implement fast failure would require every operation to check every element of the underlying collection before doing anything. Instead validation methods are provided. They can be called using the assertion facility in the client code:

      SetToCharSetAdapter s;
      ...
      assert s.validate();

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

      SetToCharSetAdapter 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 Set`	`set` The underlying set.

Constructor Summary
`SetToCharSetAdapter(Set set)` Creates a new adaption to a set of char values.
`SetToCharSetAdapter(Set set, boolean validate)` Creates a new adaption to a set of char values.

Method Summary
`boolean`	`add(char v)` Adds an element to this collection.
`void`	`clear()` Clears this collection.
`boolean`	`contains(char v)` Indicates whether this collection contains a specified element.
`void`	`evalidate()` Validates the set underlying this adapter and throws an exception if it is invalid.
`int`	`hashCode()` Returns a hash code value for this collection.
`CharIterator`	`iterator()` Returns an iterator over this collection.
`boolean`	`remove(char v)` Removes a specified element from this collection.
`int`	`size()` Returns the number of elements in this collection.
`boolean`	`validate()` Indicates whether the underlying set is valid for this adapter.

Methods inherited from class bak.pcj.set.AbstractCharSet

equals

Methods inherited from class bak.pcj.AbstractCharCollection

addAll, containsAll, isEmpty, removeAll, retainAll, toArray, toArray, toString, trimToSize

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface bak.pcj.CharCollection

addAll, containsAll, equals, isEmpty, removeAll, retainAll, toArray, toArray, trimToSize

Field Detail

set

protected Set set

The underlying set.

Constructor Detail

SetToCharSetAdapter

public SetToCharSetAdapter(Set set)

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

SetToCharSetAdapter

public SetToCharSetAdapter(Set set,
                           boolean validate)

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

Method Detail