PCJ API
Version 1.2

bak.pcj.adapter
Class CollectionToFloatCollectionAdapter

java.lang.Object
  extended bybak.pcj.AbstractFloatCollection
      extended bybak.pcj.adapter.CollectionToFloatCollectionAdapter
All Implemented Interfaces:
FloatCollection

public class CollectionToFloatCollectionAdapter
extends AbstractFloatCollection

This class represents adaptions of Java Collections Framework collections to primitive collections of float 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:

      CollectionToFloatCollectionAdapter s;
      ...
      assert s.validate();
  
or by letting the adapter throw an exception on illegal values:
      CollectionToFloatCollectionAdapter 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
CollectionToFloatCollectionAdapter(Collection collection)
          Creates a new adaption of a collection to a collection of float values.
CollectionToFloatCollectionAdapter(Collection collection, boolean validate)
          Creates a new adaption of a collection to a collection of float values.
 
Method Summary
 boolean add(float v)
          Throws UnsupportedOperationException.
 void clear()
          Clears this collection.
 boolean contains(float 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.
 FloatIterator iterator()
          Returns an iterator over this collection.
 boolean remove(float 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.AbstractFloatCollection
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.FloatCollection
equals
 

Field Detail

collection

protected Collection collection
The underlying collection.

Constructor Detail

CollectionToFloatCollectionAdapter

public CollectionToFloatCollectionAdapter(Collection collection)
Creates a new adaption of a collection to a collection of float values.

Parameters:
collection - the underlying collection. This collection must consist of values of class Float. Otherwise a ClassCastException will be thrown by some methods.
Throws:
NullPointerException - if collection is null.

CollectionToFloatCollectionAdapter

public CollectionToFloatCollectionAdapter(Collection collection,
                                          boolean validate)
Creates a new adaption of a collection to a collection of float values. The collection to adapt is optionally validated.

Parameters:
collection - the underlying collection. This collection must consist of values of class Float. 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 Float.
Method Detail

add

public boolean add(float v)
Description copied from class: AbstractFloatCollection
Throws UnsupportedOperationException.

Specified by:
add in interface FloatCollection
Overrides:
add in class AbstractFloatCollection

clear

public void clear()
Description copied from interface: FloatCollection
Clears this collection.

Specified by:
clear in interface FloatCollection
Overrides:
clear in class AbstractFloatCollection

contains

public boolean contains(float v)
Description copied from interface: FloatCollection
Indicates whether this collection contains a specified element.

Specified by:
contains in interface FloatCollection
Overrides:
contains in class AbstractFloatCollection

hashCode

public int hashCode()
Description copied from interface: FloatCollection
Returns a hash code value for this collection.


iterator

public FloatIterator iterator()
Description copied from interface: FloatCollection
Returns an iterator over this collection.

Returns:
an iterator over this collection.

remove

public boolean remove(float v)
Description copied from interface: FloatCollection
Removes a specified element from this collection.

Specified by:
remove in interface FloatCollection
Overrides:
remove in class AbstractFloatCollection

size

public int size()
Description copied from interface: FloatCollection
Returns the number of elements in this collection.

Specified by:
size in interface FloatCollection
Overrides:
size in class AbstractFloatCollection

validate

public boolean validate()
Indicates whether the underlying collection is valid for this adapter. For the underlying collection to be valid, it can only contain Float values and no null values.

Returns:
true if the underlying collection is valid; returns false otherwise.

evalidate

public void evalidate()
Validates the collection underlying this adapter and throws an exception if it is invalid. For the underlying collection to be valid, it can only contain Float values and no null values.

Throws:
IllegalStateException - if the underlying collection is invalid.

PCJ API
Version 1.2

Report a bug or request a feature.
Further information on the development and latest release of PCJ can be found at the project homepage.

Primitive Collections for Java is released under the GNU Lesser General Public License.
Copyright © 2002, 2003 Søren Bak. All Rights Reserved.

Hosted by SourceForge.net
SourceForge.net Logo