bak.pcj.adapter
Class SortedSetToLongSortedSetAdapter

java.lang.Object
  bak.pcj.AbstractLongCollection
      bak.pcj.set.AbstractLongSet
          bak.pcj.adapter.SetToLongSetAdapter
              bak.pcj.adapter.SortedSetToLongSortedSetAdapter

All Implemented Interfaces:

LongCollection, LongSet, LongSortedSet

public class SortedSetToLongSortedSetAdapter

extends SetToLongSetAdapter

implements LongSortedSet

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

      SortedSetToLongSortedSetAdapter s;
      ...
      assert s.validate();
  

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

      SortedSetToLongSortedSetAdapter 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.SetToLongSetAdapter

set

Constructor Summary

SortedSetToLongSortedSetAdapter(SortedSet set)
Creates a new adaption to a set of long values.

SortedSetToLongSortedSetAdapter(SortedSet set, boolean validate)
Creates a new adaption to a set of long values.

Method Summary

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

Methods inherited from class bak.pcj.adapter.SetToLongSetAdapter

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

Methods inherited from class bak.pcj.set.AbstractLongSet

equals

Methods inherited from class bak.pcj.AbstractLongCollection

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

add

Methods inherited from interface bak.pcj.LongCollection

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

Constructor Detail

SortedSetToLongSortedSetAdapter

public SortedSetToLongSortedSetAdapter(SortedSet set)

Creates a new adaption to a set of long values.

Parameters:

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

Throws:

NullPointerException - if set is null.

SortedSetToLongSortedSetAdapter

public SortedSetToLongSortedSetAdapter(SortedSet set,
                                       boolean validate)

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

Parameters:

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

Method Detail

first

public long first()

Description copied from interface: LongSortedSet

Returns the lowest element of this set.

Specified by:

first in interface LongSortedSet

Returns:

the lowest element of this set.

headSet

public LongSortedSet headSet(long to)

Description copied from interface: LongSortedSet

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 LongSortedSet

Parameters:

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

last

public long last()

Description copied from interface: LongSortedSet

Returns the highest element of this set.

Specified by:

last in interface LongSortedSet

Returns:

the highest element of this set.

subSet

public LongSortedSet subSet(long from,
                            long to)

Description copied from interface: LongSortedSet

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 LongSortedSet

Parameters:

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

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

tailSet

public LongSortedSet tailSet(long from)

Description copied from interface: LongSortedSet

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 LongSortedSet

Parameters:

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