bak.pcj.adapter
Class SortedSetToShortSortedSetAdapter

java.lang.Object
  bak.pcj.AbstractShortCollection
      bak.pcj.set.AbstractShortSet
          bak.pcj.adapter.SetToShortSetAdapter
              bak.pcj.adapter.SortedSetToShortSortedSetAdapter

All Implemented Interfaces:

ShortCollection, ShortSet, ShortSortedSet

public class SortedSetToShortSortedSetAdapter

extends SetToShortSetAdapter

implements ShortSortedSet

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

      SortedSetToShortSortedSetAdapter s;
      ...
      assert s.validate();
  

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

      SortedSetToShortSortedSetAdapter 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.SetToShortSetAdapter

set

Constructor Summary

SortedSetToShortSortedSetAdapter(SortedSet set)
Creates a new adaption to a set of short values.

SortedSetToShortSortedSetAdapter(SortedSet set, boolean validate)
Creates a new adaption to a set of short values.

Method Summary

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

Methods inherited from class bak.pcj.adapter.SetToShortSetAdapter

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

Methods inherited from class bak.pcj.set.AbstractShortSet

equals

Methods inherited from class bak.pcj.AbstractShortCollection

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

add

Methods inherited from interface bak.pcj.ShortCollection

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

Constructor Detail

SortedSetToShortSortedSetAdapter

public SortedSetToShortSortedSetAdapter(SortedSet set)

Creates a new adaption to a set of short values.

Parameters:

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

Throws:

NullPointerException - if set is null.

SortedSetToShortSortedSetAdapter

public SortedSetToShortSortedSetAdapter(SortedSet set,
                                        boolean validate)

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

Parameters:

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

Method Detail

first

public short first()

Description copied from interface: ShortSortedSet

Returns the lowest element of this set.

Specified by:

first in interface ShortSortedSet

Returns:

the lowest element of this set.

headSet

public ShortSortedSet headSet(short to)

Description copied from interface: ShortSortedSet

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 ShortSortedSet

Parameters:

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

last

public short last()

Description copied from interface: ShortSortedSet

Returns the highest element of this set.

Specified by:

last in interface ShortSortedSet

Returns:

the highest element of this set.

subSet

public ShortSortedSet subSet(short from,
                             short to)

Description copied from interface: ShortSortedSet

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 ShortSortedSet

Parameters:

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

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

tailSet

public ShortSortedSet tailSet(short from)

Description copied from interface: ShortSortedSet

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 ShortSortedSet

Parameters:

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