bak.pcj.adapter
Class SortedSetToCharSortedSetAdapter

java.lang.Object
  bak.pcj.AbstractCharCollection
      bak.pcj.set.AbstractCharSet
          bak.pcj.adapter.SetToCharSetAdapter
              bak.pcj.adapter.SortedSetToCharSortedSetAdapter

All Implemented Interfaces:

CharCollection, CharSet, CharSortedSet

public class SortedSetToCharSortedSetAdapter

extends SetToCharSetAdapter

implements CharSortedSet

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

      SortedSetToCharSortedSetAdapter s;
      ...
      assert s.validate();
  

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

      SortedSetToCharSortedSetAdapter 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.SetToCharSetAdapter

set

Constructor Summary

SortedSetToCharSortedSetAdapter(SortedSet set)
Creates a new adaption to a set of char values.

SortedSetToCharSortedSetAdapter(SortedSet set, boolean validate)
Creates a new adaption to a set of char values.

Method Summary

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

Methods inherited from class bak.pcj.adapter.SetToCharSetAdapter

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

Methods inherited from class bak.pcj.set.AbstractCharSet

equals

Methods inherited from class bak.pcj.AbstractCharCollection

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

add

Methods inherited from interface bak.pcj.CharCollection

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

Constructor Detail

SortedSetToCharSortedSetAdapter

public SortedSetToCharSortedSetAdapter(SortedSet set)

Creates a new adaption to a set of char values.

Parameters:

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

Throws:

NullPointerException - if set is null.

SortedSetToCharSortedSetAdapter

public SortedSetToCharSortedSetAdapter(SortedSet set,
                                       boolean validate)

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

Parameters:

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

Method Detail

first

public char first()

Description copied from interface: CharSortedSet

Returns the lowest element of this set.

Specified by:

first in interface CharSortedSet

Returns:

the lowest element of this set.

headSet

public CharSortedSet headSet(char to)

Description copied from interface: CharSortedSet

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 CharSortedSet

Parameters:

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

last

public char last()

Description copied from interface: CharSortedSet

Returns the highest element of this set.

Specified by:

last in interface CharSortedSet

Returns:

the highest element of this set.

subSet

public CharSortedSet subSet(char from,
                            char to)

Description copied from interface: CharSortedSet

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 CharSortedSet

Parameters:

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

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

tailSet

public CharSortedSet tailSet(char from)

Description copied from interface: CharSortedSet

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 CharSortedSet

Parameters:

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