bak.pcj.adapter
Class SortedSetToDoubleSortedSetAdapter

java.lang.Object
  bak.pcj.AbstractDoubleCollection
      bak.pcj.set.AbstractDoubleSet
          bak.pcj.adapter.SetToDoubleSetAdapter
              bak.pcj.adapter.SortedSetToDoubleSortedSetAdapter

All Implemented Interfaces:

DoubleCollection, DoubleSet, DoubleSortedSet

public class SortedSetToDoubleSortedSetAdapter

extends SetToDoubleSetAdapter

implements DoubleSortedSet

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

      SortedSetToDoubleSortedSetAdapter s;
      ...
      assert s.validate();
  

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

      SortedSetToDoubleSortedSetAdapter 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.SetToDoubleSetAdapter

set

Constructor Summary

SortedSetToDoubleSortedSetAdapter(SortedSet set)
Creates a new adaption to a set of double values.

SortedSetToDoubleSortedSetAdapter(SortedSet set, boolean validate)
Creates a new adaption to a set of double values.

Method Summary

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

Methods inherited from class bak.pcj.adapter.SetToDoubleSetAdapter

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

Methods inherited from class bak.pcj.set.AbstractDoubleSet

equals

Methods inherited from class bak.pcj.AbstractDoubleCollection

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

add

Methods inherited from interface bak.pcj.DoubleCollection

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

Constructor Detail

SortedSetToDoubleSortedSetAdapter

public SortedSetToDoubleSortedSetAdapter(SortedSet set)

Creates a new adaption to a set of double values.

Parameters:

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

Throws:

NullPointerException - if set is null.

SortedSetToDoubleSortedSetAdapter

public SortedSetToDoubleSortedSetAdapter(SortedSet set,
                                         boolean validate)

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

Parameters:

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

Method Detail

first

public double first()

Description copied from interface: DoubleSortedSet

Returns the lowest element of this set.

Specified by:

first in interface DoubleSortedSet

Returns:

the lowest element of this set.

headSet

public DoubleSortedSet headSet(double to)

Description copied from interface: DoubleSortedSet

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 DoubleSortedSet

Parameters:

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

last

public double last()

Description copied from interface: DoubleSortedSet

Returns the highest element of this set.

Specified by:

last in interface DoubleSortedSet

Returns:

the highest element of this set.

subSet

public DoubleSortedSet subSet(double from,
                              double to)

Description copied from interface: DoubleSortedSet

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 DoubleSortedSet

Parameters:

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

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

tailSet

public DoubleSortedSet tailSet(double from)

Description copied from interface: DoubleSortedSet

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 DoubleSortedSet

Parameters:

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