it.unimi.dsi.fastutil.objects
Class ReferenceSortedSets.Singleton<K>

java.lang.Object
  extended by java.util.AbstractCollection<K>
      extended by it.unimi.dsi.fastutil.objects.AbstractReferenceCollection<K>
          extended by it.unimi.dsi.fastutil.objects.AbstractReferenceSet<K>
              extended by it.unimi.dsi.fastutil.objects.ReferenceSets.Singleton<K>
                  extended by it.unimi.dsi.fastutil.objects.ReferenceSortedSets.Singleton<K>
All Implemented Interfaces:
ObjectIterable<K>, ReferenceCollection<K>, ReferenceSet<K>, ReferenceSortedSet<K>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<K>, java.util.Collection<K>, java.util.Set<K>, java.util.SortedSet<K>
Enclosing class:
ReferenceSortedSets

public static class ReferenceSortedSets.Singleton<K>
extends ReferenceSets.Singleton<K>
implements ReferenceSortedSet<K>, java.io.Serializable, java.lang.Cloneable

A class representing a singleton sorted set.

This class may be useful to implement your own in case you subclass a type-specific sorted set.

See Also:
Serialized Form

Method Summary
 java.util.Comparator<? super K> comparator()
           
 K first()
           
 ReferenceSortedSet<K> headSet(K to)
          Returns a view of the portion of this sorted set whose elements are strictly less than toElement.
 ObjectBidirectionalIterator<K> iterator(K from)
          Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
 K last()
           
 ObjectBidirectionalIterator<K> objectIterator()
          Deprecated. 
 ReferenceSortedSet<K> subSet(K from, K to)
          Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.
 ReferenceSortedSet<K> tailSet(K from)
          Returns a view of the portion of this sorted set whose elements are greater than or equal to fromElement.
 
Methods inherited from class it.unimi.dsi.fastutil.objects.ReferenceSets.Singleton
add, addAll, clone, contains, iterator, removeAll, retainAll, size
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractReferenceSet
equals, hashCode, remove
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractReferenceCollection
containsAll, isEmpty, toArray, toArray, toString
 
Methods inherited from class java.util.AbstractCollection
clear
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.objects.ReferenceSortedSet
iterator
 
Methods inherited from interface it.unimi.dsi.fastutil.objects.ReferenceSet
remove
 
Methods inherited from interface it.unimi.dsi.fastutil.objects.ReferenceCollection
toArray
 
Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, size, toArray, toArray
 

Method Detail

objectIterator

@Deprecated
public ObjectBidirectionalIterator<K> objectIterator()
Deprecated. 

Description copied from class: AbstractReferenceCollection
Delegates to the new covariantly stronger generic method.

Specified by:
objectIterator in interface ReferenceCollection<K>
Specified by:
objectIterator in interface ReferenceSortedSet<K>
Overrides:
objectIterator in class AbstractReferenceCollection<K>
See Also:
ReferenceCollection.iterator()

iterator

public ObjectBidirectionalIterator<K> iterator(K from)
Description copied from interface: ReferenceSortedSet
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.

Specified by:
iterator in interface ReferenceSortedSet<K>
Parameters:
from - an element to start from.
Returns:
a bidirectional iterator on the element in this set, starting at the given element.

comparator

public java.util.Comparator<? super K> comparator()
Specified by:
comparator in interface java.util.SortedSet<K>

subSet

public ReferenceSortedSet<K> subSet(K from,
                                    K to)
Description copied from interface: ReferenceSortedSet
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 ReferenceSortedSet<K>
Specified by:
subSet in interface java.util.SortedSet<K>
See Also:
SortedSet.subSet(Object,Object)

headSet

public ReferenceSortedSet<K> headSet(K to)
Description copied from interface: ReferenceSortedSet
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 ReferenceSortedSet<K>
Specified by:
headSet in interface java.util.SortedSet<K>
See Also:
SortedSet.headSet(Object)

tailSet

public ReferenceSortedSet<K> tailSet(K from)
Description copied from interface: ReferenceSortedSet
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 ReferenceSortedSet<K>
Specified by:
tailSet in interface java.util.SortedSet<K>
See Also:
SortedSet.tailSet(Object)

first

public K first()
Specified by:
first in interface java.util.SortedSet<K>

last

public K last()
Specified by:
last in interface java.util.SortedSet<K>