bak.pcj.adapter
Class SortedSetToIntSortedSetAdapter

java.lang.Object
  bak.pcj.AbstractIntCollection
      bak.pcj.set.AbstractIntSet
          bak.pcj.adapter.SetToIntSetAdapter
              bak.pcj.adapter.SortedSetToIntSortedSetAdapter

All Implemented Interfaces:

IntCollection, IntSet, IntSortedSet

public class SortedSetToIntSortedSetAdapter

extends SetToIntSetAdapter

implements IntSortedSet

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

      SortedSetToIntSortedSetAdapter s;
      ...
      assert s.validate();
  

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

      SortedSetToIntSortedSetAdapter 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.SetToIntSetAdapter

set

Constructor Summary

SortedSetToIntSortedSetAdapter(SortedSet set)
Creates a new adaption to a set of int values.

SortedSetToIntSortedSetAdapter(SortedSet set, boolean validate)
Creates a new adaption to a set of int values.

Method Summary

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

Methods inherited from class bak.pcj.adapter.SetToIntSetAdapter

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

Methods inherited from class bak.pcj.set.AbstractIntSet

equals

Methods inherited from class bak.pcj.AbstractIntCollection

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

add

Methods inherited from interface bak.pcj.IntCollection

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

Constructor Detail

SortedSetToIntSortedSetAdapter

public SortedSetToIntSortedSetAdapter(SortedSet set)

Creates a new adaption to a set of int values.

Parameters:

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

Throws:

NullPointerException - if set is null.

SortedSetToIntSortedSetAdapter

public SortedSetToIntSortedSetAdapter(SortedSet set,
                                      boolean validate)

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

Parameters:

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

Method Detail

first

public int first()

Description copied from interface: IntSortedSet

Returns the lowest element of this set.

Specified by:

first in interface IntSortedSet

Returns:

the lowest element of this set.

headSet

public IntSortedSet headSet(int to)

Description copied from interface: IntSortedSet

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 IntSortedSet

Parameters:

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

last

public int last()

Description copied from interface: IntSortedSet

Returns the highest element of this set.

Specified by:

last in interface IntSortedSet

Returns:

the highest element of this set.

subSet

public IntSortedSet subSet(int from,
                           int to)

Description copied from interface: IntSortedSet

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 IntSortedSet

Parameters:

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

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

tailSet

public IntSortedSet tailSet(int from)

Description copied from interface: IntSortedSet

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 IntSortedSet

Parameters:

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