bak.pcj.adapter
Class SortedSetToFloatSortedSetAdapter

java.lang.Object
  bak.pcj.AbstractFloatCollection
      bak.pcj.set.AbstractFloatSet
          bak.pcj.adapter.SetToFloatSetAdapter
              bak.pcj.adapter.SortedSetToFloatSortedSetAdapter

All Implemented Interfaces:

FloatCollection, FloatSet, FloatSortedSet

public class SortedSetToFloatSortedSetAdapter

extends SetToFloatSetAdapter

implements FloatSortedSet

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

      SortedSetToFloatSortedSetAdapter s;
      ...
      assert s.validate();
  

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

      SortedSetToFloatSortedSetAdapter s;
      ...
      s.evalidate();  // Throws an exception on illegal values
  

Either way, validation must be invoked directly by the client code.

Since:

1.2

Field Summary

Fields inherited from class bak.pcj.adapter.SetToFloatSetAdapter

set

Constructor Summary

SortedSetToFloatSortedSetAdapter(SortedSet set)
Creates a new adaption to a set of float values.

SortedSetToFloatSortedSetAdapter(SortedSet set, boolean validate)
Creates a new adaption to a set of float values.

Method Summary

float	first() Returns the lowest element of this set.
FloatSortedSet	headSet(float to) Returns the subset of values lower than a specified value.
float	last() Returns the highest element of this set.
FloatSortedSet	subSet(float from, float to) Returns the subset of values lower that a specified value and higher than or equal to another specified value.
FloatSortedSet	tailSet(float from) Returns the subset of values higher than or equal to a specified value.

Methods inherited from class bak.pcj.adapter.SetToFloatSetAdapter

add, clear, contains, evalidate, hashCode, iterator, remove, size, validate

Methods inherited from class bak.pcj.set.AbstractFloatSet

equals

Methods inherited from class bak.pcj.AbstractFloatCollection

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.set.FloatSortedSet

add

Methods inherited from interface bak.pcj.FloatCollection

addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, trimToSize

Constructor Detail

SortedSetToFloatSortedSetAdapter

public SortedSetToFloatSortedSetAdapter(SortedSet set)

Creates a new adaption to a set of float values.

Parameters:

set - the underlying set. This set must consist of values of class Float. Otherwise a ClassCastException will be thrown by some methods.

Throws:

NullPointerException - if set is null.

SortedSetToFloatSortedSetAdapter

public SortedSetToFloatSortedSetAdapter(SortedSet set,
                                        boolean validate)

Creates a new adaption to a set of float values. The set to adapt is optionally validated.

Parameters:

set - the underlying set. This set must consist of values of class Float. 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 Float.

Method Detail

first

public float first()

Description copied from interface: FloatSortedSet

Returns the lowest element of this set.

Specified by:

first in interface FloatSortedSet

Returns:

the lowest element of this set.

headSet

public FloatSortedSet headSet(float to)

Description copied from interface: FloatSortedSet

Returns the subset of values lower than a specified value. The returned subset is a view of this set, so changes to the subset are reflected by this set and vice versa.

Specified by:

headSet in interface FloatSortedSet

Parameters:

to - the upper bound of the returned set (not included).

last

public float last()

Description copied from interface: FloatSortedSet

Returns the highest element of this set.

Specified by:

last in interface FloatSortedSet

Returns:

the highest element of this set.

subSet

public FloatSortedSet subSet(float from,
                             float to)

Description copied from interface: FloatSortedSet

Returns the subset of values lower that a specified value and higher than or equal to another specified value. The returned subset is a view of this set, so changes to the subset are reflected by this set and vice versa.

Specified by:

subSet in interface FloatSortedSet

Parameters:

from - the lower bound of the returned set (included).

to - the upper bound of the returned set (not included).

tailSet

public FloatSortedSet tailSet(float from)

Description copied from interface: FloatSortedSet

Returns the subset of values higher than or equal to a specified value. The returned subset is a view of this set, so changes to the subset are reflected by this set and vice versa.

Specified by:

tailSet in interface FloatSortedSet

Parameters:

from - the lower bound of the returned set (included).