Module org.jhotdraw8.icollection

Package org.jhotdraw8.icollection.readonly

Interface ReadOnlyNavigableSet<E>

Type Parameters:

E - the element type

All Superinterfaces:

Iterable<E>, ReadOnlyCollection<E>, ReadOnlySequencedCollection<E>, ReadOnlySequencedSet<E>, ReadOnlySet<E>, ReadOnlySortedSet<E>

All Known Subinterfaces:

ImmutableNavigableSet<E>

All Known Implementing Classes:

MutableRedBlackSet, ReadOnlyNavigableSetFacade, RedBlackSet

public interface ReadOnlyNavigableSet<E>
extends ReadOnlySortedSet<E>

A read-only interface to a navigable set.

Method Summary

Modifier and Type	Method	Description
@Nullable E	ceiling(E e)	Returns the least element in this set greater than or equal to the given element, or null if there is no such element.
@Nullable E	floor(E e)	Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.
@Nullable E	higher(E e)	Returns the least element in this set greater than the given element, or null if there is no such element.
@Nullable E	lower(E e)	Returns the greatest element in this set less than the given element, or null if there is no such element.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlyCollection

contains, containsAll, isEmpty, iterator, size, stream, toArray, toArray

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlySequencedCollection

asCollection, getFirst, getLast

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlySequencedSet

asSet, readOnlyReversed

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlySet

characteristics, equals, hashCode

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlySortedSet

comparator

Method Details

ceiling

@Nullable E ceiling(E e)

Returns the least element in this set greater than or equal to the given element, or null if there is no such element.

Parameters:

e - the given element

Returns:

ceiling element or null

floor

@Nullable E floor(E e)

Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.

Parameters:

e - the given element

Returns:

floor element or null

higher

@Nullable E higher(E e)

Returns the least element in this set greater than the given element, or null if there is no such element.

Parameters:

e - the given element

Returns:

higher element or null

lower

@Nullable E lower(E e)

Returns the greatest element in this set less than the given element, or null if there is no such element.

Parameters:

e - the given element

Returns:

lower element or null