Summary: Methods | Inherited Methods | [Expand All]

Since: API Level 9

public interface

NavigableSet

implements SortedSet<E>

java.util.NavigableSet<E>

Known Indirect Subclasses

ConcurrentSkipListSet<E>, TreeSet<E>

Class Overview

NavigableSet is a SortedSet with navigation methods answering the closest matches for specified item.

Summary

Public Methods
abstract E	ceiling(E e) Returns the smallest element bigger than or equal to the specified one, or null if no such element.
abstract Iterator<E>	descendingIterator() Returns a descending iterator of this set.
abstract NavigableSet<E>	descendingSet() Returns a reverse order view of this set.
abstract E	floor(E e) Returns the biggest element less than or equal to the specified one, or null if no such element.
abstract NavigableSet<E>	headSet(E end, boolean endInclusive) Returns a NavigableSet of the specified portion of this set which contains elements less than (or equal to, depends on endInclusive) the end element.
abstract E	higher(E e) Returns the smallest element bigger than the specified one, or null if no such element.
abstract E	lower(E e) Returns the biggest element less than the specified one, or null if no such element.
abstract E	pollFirst() Deletes and returns the smallest element, or null if the set is empty.
abstract E	pollLast() Deletes and returns the biggest element, or null if the set is empty.
abstract NavigableSet<E>	subSet(E start, boolean startInclusive, E end, boolean endInclusive) Returns a NavigableSet of the specified portion of this set which contains elements greater (or equal to, depends on startInclusive) the start element but less than (or equal to, depends on endInclusive) the end element.
abstract NavigableSet<E>	tailSet(E start, boolean startInclusive) Returns a NavigableSet of the specified portion of this set which contains elements greater (or equal to, depends on startInclusive) the start element.

[Expand]

Inherited Methods

From interface java.lang.Iterable

From interface java.util.Collection

abstract boolean	add(E object) Attempts to add `object` to the contents of this `Collection` (optional).
abstract boolean	addAll(Collection<? extends E> collection) Attempts to add all of the objects contained in `Collection` to the contents of this `Collection` (optional).
abstract void	clear() Removes all elements from this `Collection`, leaving it empty (optional).
abstract boolean	contains(Object object) Tests whether this `Collection` contains the specified object.
abstract boolean	containsAll(Collection<?> collection) Tests whether this `Collection` contains all objects contained in the specified `Collection`.
abstract boolean	equals(Object object) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
abstract int	hashCode() Returns an integer hash code for the receiver.
abstract boolean	isEmpty() Returns if this `Collection` contains no elements.
abstract Iterator<E>	iterator() Returns an instance of `Iterator` that may be used to access the objects contained by this `Collection`.
abstract boolean	remove(Object object) Removes one instance of the specified object from this `Collection` if one is contained (optional).
abstract boolean	removeAll(Collection<?> collection) Removes all occurrences in this `Collection` of each object in the specified `Collection` (optional).
abstract boolean	retainAll(Collection<?> collection) Removes all objects from this `Collection` that are not also found in the `Collection` passed (optional).
abstract int	size() Returns a count of how many objects this `Collection` contains.
abstract <T> T[]	toArray(T[] array) Returns an array containing all elements contained in this `Collection`.
abstract Object[]	toArray() Returns a new array containing all elements contained in this `Collection`.

From interface java.util.Set

abstract boolean	add(E object) Adds the specified object to this set.
abstract boolean	addAll(Collection<? extends E> collection) Adds the objects in the specified collection which do not exist yet in this set.
abstract void	clear() Removes all elements from this set, leaving it empty.
abstract boolean	contains(Object object) Searches this set for the specified object.
abstract boolean	containsAll(Collection<?> collection) Searches this set for all objects in the specified collection.
abstract boolean	equals(Object object) Compares the specified object to this set, and returns true if they represent the same object using a class specific comparison.
abstract int	hashCode() Returns the hash code for this set.
abstract boolean	isEmpty() Returns true if this set has no elements.
abstract Iterator<E>	iterator() Returns an iterator on the elements of this set.
abstract boolean	remove(Object object) Removes the specified object from this set.
abstract boolean	removeAll(Collection<?> collection) Removes all objects in the specified collection from this set.
abstract boolean	retainAll(Collection<?> collection) Removes all objects from this set that are not contained in the specified collection.
abstract int	size() Returns the number of elements in this set.
abstract <T> T[]	toArray(T[] array) Returns an array containing all elements contained in this set.
abstract Object[]	toArray() Returns an array containing all elements contained in this set.

From interface java.util.SortedSet

Public Methods

public abstract E ceiling (E e)

Since: API Level 9

Returns the smallest element bigger than or equal to the specified one, or null if no such element.

Parameters

e	the specified element

Returns

the smallest element bigger than or equal to the specified one, or null if no such element

Throws

ClassCastException	if the element cannot be compared with the ones in the set
NullPointerException	if the element is null and the set can not contain null

public abstract Iterator<E> descendingIterator ()

Since: API Level 9

Returns a descending iterator of this set.

Returns

the descending iterator

public abstract NavigableSet<E> descendingSet ()

Since: API Level 9

Returns a reverse order view of this set.

Returns

the reverse order view

public abstract E floor (E e)

Since: API Level 9

Returns the biggest element less than or equal to the specified one, or null if no such element.

Parameters

e	the specified element

Returns

the biggest element less than or equal to the specified one, or null if no such element

Throws

ClassCastException	if the element cannot be compared with the ones in the set
NullPointerException	if the element is null and the set can not contain null

public abstract NavigableSet<E> headSet (E end, boolean endInclusive)

Since: API Level 9

Returns a NavigableSet of the specified portion of this set which contains elements less than (or equal to, depends on endInclusive) the end element. The returned NavigableSet is backed by this set so changes to one are reflected by the other.

Parameters

end	the end element
endInclusive	true if the end element is in the returned set

Returns

the subset

Throws

ClassCastException	when the end object cannot be compared with the elements in this set
NullPointerException	when the end object is null and the set cannot contain handle null
IllegalArgumentException	when end is out of range and the set has a range

public abstract E higher (E e)

Since: API Level 9

Returns the smallest element bigger than the specified one, or null if no such element.

Parameters

e	the specified element

Returns

the smallest element bigger than the specified one, or null if no such element

Throws

ClassCastException	if the element cannot be compared with the ones in the set
NullPointerException	if the element is null and the set can not contain null

public abstract E lower (E e)

Since: API Level 9

Returns the biggest element less than the specified one, or null if no such element.

Parameters

e	the specified element

Returns

the biggest element less than the specified one, or null if no such element

Throws

ClassCastException	if the element cannot be compared with the ones in the set
NullPointerException	if the element is null and the set can not contain null

public abstract E pollFirst ()

Since: API Level 9

Deletes and returns the smallest element, or null if the set is empty.

Returns

the smallest element, or null if the set is empty

public abstract E pollLast ()

Since: API Level 9

Deletes and returns the biggest element, or null if the set is empty.

Returns

the biggest element, or null if the set is empty

public abstract NavigableSet<E> subSet (E start, boolean startInclusive, E end, boolean endInclusive)

Since: API Level 9

Returns a NavigableSet of the specified portion of this set which contains elements greater (or equal to, depends on startInclusive) the start element but less than (or equal to, depends on endInclusive) the end element. The returned NavigableSet is backed by this set so changes to one are reflected by the other.

Parameters

start	the start element
startInclusive	true if the start element is in the returned set
end	the end element
endInclusive	true if the end element is in the returned set

Returns

the subset

Throws

ClassCastException	when the start or end object cannot be compared with the elements in this set
NullPointerException	when the start or end object is null and the set cannot contain null
IllegalArgumentException	when the start is bigger than end; or start or end is out of range and the set has a range

public abstract NavigableSet<E> tailSet (E start, boolean startInclusive)

Since: API Level 9

Returns a NavigableSet of the specified portion of this set which contains elements greater (or equal to, depends on startInclusive) the start element. The returned NavigableSet is backed by this set so changes to one are reflected by the other.

Parameters

start	the start element
startInclusive	true if the start element is in the returned set

Returns

the subset

Throws

ClassCastException	when the start object cannot be compared with the elements in this set
NullPointerException	when the start object is null and the set cannot contain null
IllegalArgumentException	when start is out of range and the set has a range

Interfaces

Classes

Enums

Exceptions

Errors

NavigableSet

Class Overview

Summary

Public Methods

public abstract E ceiling (E e)

Parameters

Returns

Throws

public abstract Iterator<E> descendingIterator ()

Returns

public abstract NavigableSet<E> descendingSet ()

Returns

public abstract E floor (E e)

Parameters

Returns

Throws

public abstract NavigableSet<E> headSet (E end, boolean endInclusive)

Parameters

Returns

Throws

public abstract E higher (E e)

Parameters

Returns

Throws

public abstract E lower (E e)

Parameters

Returns

Throws

public abstract E pollFirst ()

Returns

public abstract E pollLast ()

Returns

public abstract NavigableSet<E> subSet (E start, boolean startInclusive, E end, boolean endInclusive)

Parameters

Returns

Throws

public abstract NavigableSet<E> tailSet (E start, boolean startInclusive)

Parameters

Returns

Throws