bak.pcj.adapter
Class SortedSetToByteSortedSetAdapter

java.lang.Object
  bak.pcj.AbstractByteCollection
      bak.pcj.set.AbstractByteSet
          bak.pcj.adapter.SetToByteSetAdapter
              bak.pcj.adapter.SortedSetToByteSortedSetAdapter

All Implemented Interfaces:

ByteCollection, ByteSet, ByteSortedSet

public class SortedSetToByteSortedSetAdapter

extends SetToByteSetAdapter

implements ByteSortedSet

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

      SortedSetToByteSortedSetAdapter s;
      ...
      assert s.validate();
  

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

      SortedSetToByteSortedSetAdapter 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.SetToByteSetAdapter

set

Constructor Summary

SortedSetToByteSortedSetAdapter(SortedSet set)
Creates a new adaption to a set of byte values.

SortedSetToByteSortedSetAdapter(SortedSet set, boolean validate)
Creates a new adaption to a set of byte values.

Method Summary

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

Methods inherited from class bak.pcj.adapter.SetToByteSetAdapter

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

Methods inherited from class bak.pcj.set.AbstractByteSet

equals

Methods inherited from class bak.pcj.AbstractByteCollection

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

add

Methods inherited from interface bak.pcj.ByteCollection

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

Constructor Detail

SortedSetToByteSortedSetAdapter

public SortedSetToByteSortedSetAdapter(SortedSet set)

Creates a new adaption to a set of byte values.

Parameters:

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

Throws:

NullPointerException - if set is null.

SortedSetToByteSortedSetAdapter

public SortedSetToByteSortedSetAdapter(SortedSet set,
                                       boolean validate)

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

Parameters:

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

Method Detail

first

public byte first()

Description copied from interface: ByteSortedSet

Returns the lowest element of this set.

Specified by:

first in interface ByteSortedSet

Returns:

the lowest element of this set.

headSet

public ByteSortedSet headSet(byte to)

Description copied from interface: ByteSortedSet

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 ByteSortedSet

Parameters:

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

last

public byte last()

Description copied from interface: ByteSortedSet

Returns the highest element of this set.

Specified by:

last in interface ByteSortedSet

Returns:

the highest element of this set.

subSet

public ByteSortedSet subSet(byte from,
                            byte to)

Description copied from interface: ByteSortedSet

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 ByteSortedSet

Parameters:

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

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

tailSet

public ByteSortedSet tailSet(byte from)

Description copied from interface: ByteSortedSet

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 ByteSortedSet

Parameters:

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