it.unimi.dsi.fastutil.chars
Interface CharSortedSet

All Superinterfaces:
CharCollection, CharIterable, CharSet, Collection<Character>, Iterable<Character>, Set<Character>, SortedSet<Character>
All Known Implementing Classes:
AbstractCharSortedSet, CharAVLTreeSet, CharLinkedOpenHashSet, CharRBTreeSet, CharSortedSets.EmptySet, CharSortedSets.Singleton, CharSortedSets.SynchronizedSortedSet, CharSortedSets.UnmodifiableSortedSet

public interface CharSortedSet
extends CharSet, SortedSet<Character>

A type-specific SortedSet; provides some additional methods that use polymorphism to avoid (un)boxing.

Additionally, this interface strengthens iterator(), comparator() (for primitive types), SortedSet.subSet(Object,Object), SortedSet.headSet(Object) and SortedSet.tailSet(Object).

See Also:
SortedSet

Method Summary
 CharBidirectionalIterator charIterator()
          Deprecated. As of fastutil 5, replaced by iterator().
 CharComparator comparator()
          Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
 char firstChar()
           
 CharSortedSet headSet(char toElement)
           
 CharSortedSet headSet(Character toElement)
          Returns a view of the portion of this sorted set whose elements are strictly less than toElement.
 CharBidirectionalIterator iterator()
          Returns a type-specific BidirectionalIterator on the elements in this set.
 CharBidirectionalIterator iterator(char fromElement)
          Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
 char lastChar()
           
 CharSortedSet subSet(Character fromElement, Character toElement)
          Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.
 CharSortedSet subSet(char fromElement, char toElement)
           
 CharSortedSet tailSet(char fromElement)
           
 CharSortedSet tailSet(Character fromElement)
          Returns a view of the portion of this sorted set whose elements are greater than or equal to fromElement.
 
Methods inherited from interface it.unimi.dsi.fastutil.chars.CharSet
remove
 
Methods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection
add, addAll, contains, containsAll, rem, removeAll, retainAll, toArray, toArray, toCharArray, toCharArray
 
Methods inherited from interface java.util.SortedSet
first, last
 
Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray
 

Method Detail

iterator

CharBidirectionalIterator iterator(char fromElement)
Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).

This method returns a type-specific bidirectional iterator with given starting point. The starting point is any element comparable to the elements of this set (even if it does not actually belong to the set). The next element of the returned iterator is the least element of the set that is greater than the starting point (if there are no elements greater than the starting point, hasNext() will return false). The previous element of the returned iterator is the greatest element of the set that is smaller than or equal to the starting point (if there are no elements smaller than or equal to the starting point, hasPrevious() will return false).

Note that passing the last element of the set as starting point and calling previous() you can traverse the entire set in reverse order.

Parameters:
fromElement - an element to start from.
Returns:
a bidirectional iterator on the element in this set, starting at the given element.
Throws:
UnsupportedOperationException - if this set does not support iterators with a starting point.

charIterator

@Deprecated
CharBidirectionalIterator charIterator()
Deprecated. As of fastutil 5, replaced by iterator().

Returns a type-specific BidirectionalIterator iterator on the collection.

The iterator returned by the iterator() method and by this method are identical; however, using this method you can save a type casting. Note that this specification strengthens the one given in the corresponding type-specific Collection.

Specified by:
charIterator in interface CharCollection
See Also:
CharCollection.iterator()

iterator

CharBidirectionalIterator iterator()
Returns a type-specific BidirectionalIterator on the elements in this set.

This method returns a parameterised bidirectional iterator. The iterator can be moreover safely cast to a type-specific iterator. Note that this specification strengthens the one given in the corresponding type-specific Collection.

Specified by:
iterator in interface CharCollection
Specified by:
iterator in interface CharIterable
Specified by:
iterator in interface CharSet
Specified by:
iterator in interface Collection<Character>
Specified by:
iterator in interface Iterable<Character>
Specified by:
iterator in interface Set<Character>
Returns:
a bidirectional iterator on the element in this set.

subSet

CharSortedSet subSet(Character fromElement,
                     Character toElement)
Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.

Note that this specification strengthens the one given in SortedSet.subSet(Object,Object).

Specified by:
subSet in interface SortedSet<Character>
See Also:
SortedSet.subSet(Object,Object)

headSet

CharSortedSet headSet(Character toElement)
Returns a view of the portion of this sorted set whose elements are strictly less than toElement.

Note that this specification strengthens the one given in SortedSet.headSet(Object).

Specified by:
headSet in interface SortedSet<Character>
See Also:
SortedSet.headSet(Object)

tailSet

CharSortedSet tailSet(Character fromElement)
Returns a view of the portion of this sorted set whose elements are greater than or equal to fromElement.

Note that this specification strengthens the one given in SortedSet.tailSet(Object).

Specified by:
tailSet in interface SortedSet<Character>
See Also:
SortedSet.tailSet(Object)

comparator

CharComparator comparator()
Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.

Note that this specification strengthens the one given in SortedSet.comparator().

Specified by:
comparator in interface SortedSet<Character>
See Also:
SortedSet.comparator()

subSet

CharSortedSet subSet(char fromElement,
                     char toElement)
See Also:
SortedSet.subSet(Object,Object)

headSet

CharSortedSet headSet(char toElement)
See Also:
SortedSet.headSet(Object)

tailSet

CharSortedSet tailSet(char fromElement)
See Also:
SortedSet.tailSet(Object)

firstChar

char firstChar()
See Also:
SortedSet.first()

lastChar

char lastChar()
See Also:
SortedSet.last()