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

java.lang.Object
  bak.pcj.AbstractCharCollection
      bak.pcj.adapter.CollectionToCharCollectionAdapter

All Implemented Interfaces:: CharCollection

public class CollectionToCharCollectionAdapter
extends AbstractCharCollection

This class represents adaptions of Java Collections Framework collections to primitive collections of char values. The adapter is implemented as a wrapper around the collection. Thus, changes to the underlying collection are reflected by this collection 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:

      CollectionToCharCollectionAdapter s;
      ...
      assert s.validate();

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

      CollectionToCharCollectionAdapter 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 Collection`	`collection` The underlying collection.

Constructor Summary
`CollectionToCharCollectionAdapter(Collection collection)` Creates a new adaption of a collection to a collection of char values.
`CollectionToCharCollectionAdapter(Collection collection, boolean validate)` Creates a new adaption of a collection to a collection of char values.

Method Summary
`boolean`	`add(char v)` Throws `UnsupportedOperationException`.
`void`	`clear()` Clears this collection.
`boolean`	`contains(char v)` Indicates whether this collection contains a specified element.
`void`	`evalidate()` Validates the collection 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 collection is valid for this adapter.

Methods inherited from class bak.pcj.AbstractCharCollection

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface bak.pcj.CharCollection

equals

Field Detail

collection

protected Collection collection

The underlying collection.

Constructor Detail

CollectionToCharCollectionAdapter

public CollectionToCharCollectionAdapter(Collection collection)

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

CollectionToCharCollectionAdapter

public CollectionToCharCollectionAdapter(Collection collection,
                                         boolean validate)

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

Method Detail

add

public boolean add(char v)

Description copied from class: AbstractCharCollection

Throws UnsupportedOperationException.

Specified by:: add in interface CharCollection
Overrides:: add in class AbstractCharCollection