File Doc Category Size Date Package
SortedSet.java API Doc Android 1.5 API 4908 Wed May 06 22:41:04 BST 2009 java.util

SortedSet

public interface SortedSet implements Set

SortedSet is a Set which iterates over its elements in a sorted order. The order is determined either by the elements natural ordering, or by a {@link Comparator} which is passed into a concrete implementation at construction time. All elements in this set must be mutually comparable. The ordering in this set must be consistent with {@code equals} of its elements.

see: Comparator
see: Comparable
since: Android 1.0

Fields Summary
Constructors Summary
Methods Summary
public java.util.Comparator comparator()
Returns the comparator used to compare elements in this {@code SortedSet}.
return
a comparator or null if the natural ordering is used.
since
Android 1.0
public E first()
Returns the first element in this {@code SortedSet}. The first element is the lowest element.
return
the first element.
throws
NoSuchElementException when this {@code SortedSet} is empty.
since
Android 1.0
public java.util.SortedSet headSet(E end)
Returns a {@code SortedSet} of the specified portion of this {@code SortedSet} which contains elements less than the end element. The returned {@code SortedSet} is backed by this {@code SortedSet} so changes to one set are reflected by the other.
param
end the end element.
return
a subset where the elements are less than {@code end}.
throws
ClassCastException when the class of the end element is inappropriate for this SubSet.
throws
NullPointerException when the end element is null and this {@code SortedSet} does not support null elements.
since
Android 1.0
public E last()
Returns the last element in this {@code SortedSet}. The last element is the highest element.
return
the last element.
throws
NoSuchElementException when this {@code SortedSet} is empty.
since
Android 1.0
public java.util.SortedSet subSet(E start, E end)
Returns a {@code SortedSet} of the specified portion of this {@code SortedSet} which contains elements greater or equal to the start element but less than the end element. The returned {@code SortedSet} is backed by this SortedMap so changes to one set are reflected by the other.
param
start the start element.
param
end the end element.
return
a subset where the elements are greater or equal to {@code start} and less than {@code end}.
throws
ClassCastException when the class of the start or end element is inappropriate for this SubSet.
throws
NullPointerException when the start or end element is null and this {@code SortedSet} does not support null elements.
throws
IllegalArgumentException when the start element is greater than the end element.
since
Android 1.0
public java.util.SortedSet tailSet(E start)
Returns a {@code SortedSet} of the specified portion of this {@code SortedSet} which contains elements greater or equal to the start element. The returned {@code SortedSet} is backed by this {@code SortedSet} so changes to one set are reflected by the other.
param
start the start element.
return
a subset where the elements are greater or equal to {@code start} .
throws
ClassCastException when the class of the start element is inappropriate for this SubSet.
throws
NullPointerException when the start element is null and this {@code SortedSet} does not support null elements.
since
Android 1.0