Module org.jhotdraw8.icollection

Package org.jhotdraw8.icollection.facade

Class ReadOnlyNavigableSetFacade<E>

java.lang.Object

org.jhotdraw8.icollection.readonly.AbstractReadOnlyCollection<E>

org.jhotdraw8.icollection.readonly.AbstractReadOnlySet<E>

org.jhotdraw8.icollection.facade.ReadOnlySetFacade<E>

org.jhotdraw8.icollection.facade.ReadOnlyNavigableSetFacade<E>

Type Parameters:

E - the element type

All Implemented Interfaces:

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

public class ReadOnlyNavigableSetFacade<E>
extends ReadOnlySetFacade<E>
implements ReadOnlyNavigableSet<E>

Provides a ReadOnlyNavigableSet facade to a set of NavigableSet functions.

Author:

Werner Randelshofer

Field Summary

Fields inherited from class org.jhotdraw8.icollection.facade.ReadOnlySetFacade

characteristics, containsFunction, iteratorFunction, sizeFunction

Constructor Summary

Constructors

Constructor	Description
ReadOnlyNavigableSetFacade(@NonNull NavigableSet<E> s)
ReadOnlyNavigableSetFacade(@NonNull Supplier<Iterator<E>> iteratorFunction, @NonNull Supplier<Iterator<E>> reverseIteratorFunction, @NonNull IntSupplier sizeFunction, @NonNull Predicate<Object> containsFunction, @NonNull Supplier<E> getFirstFunction, @NonNull Supplier<E> getLastFunction, @NonNull Function<E,E> ceilingFunction, @NonNull Function<E,E> floorFunction, @NonNull Function<E,E> higherFunction, @NonNull Function<E,E> lowerFunction, @NonNull Supplier<Comparator<? super E>> comparatorSupplier, int characteristics)

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 Comparator<? super E>	comparator()	Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.
@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.
E	getFirst()	Gets the first element.
E	getLast()	Gets the last 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.
@NonNull ReadOnlyNavigableSet<E>	readOnlyReversed()	Returns a reversed-order view of this set.

Methods inherited from class org.jhotdraw8.icollection.facade.ReadOnlySetFacade

contains, hashCode, iterator, size, spliterator

Methods inherited from class org.jhotdraw8.icollection.readonly.AbstractReadOnlySet

equals

Methods inherited from class org.jhotdraw8.icollection.readonly.AbstractReadOnlyCollection

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

asSet

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

characteristics, equals, hashCode

Constructor Details

ReadOnlyNavigableSetFacade

public ReadOnlyNavigableSetFacade(@NonNull NavigableSet<E> s)

ReadOnlyNavigableSetFacade

public ReadOnlyNavigableSetFacade(@NonNull Supplier<Iterator<E>> iteratorFunction,
 @NonNull Supplier<Iterator<E>> reverseIteratorFunction,
 @NonNull IntSupplier sizeFunction,
 @NonNull Predicate<Object> containsFunction,
 @NonNull Supplier<E> getFirstFunction,
 @NonNull Supplier<E> getLastFunction,
 @NonNull Function<E,E> ceilingFunction,
 @NonNull Function<E,E> floorFunction,
 @NonNull Function<E,E> higherFunction,
 @NonNull Function<E,E> lowerFunction,
 @NonNull Supplier<Comparator<? super E>> comparatorSupplier,
 int characteristics)

Method Details

ceiling

public @Nullable E ceiling(E e)

Description copied from interface: ReadOnlyNavigableSet

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

Specified by:

ceiling in interface ReadOnlyNavigableSet<E>

Parameters:

e - the given element

Returns:

ceiling element or null

comparator

public @Nullable Comparator<? super E> comparator()

Description copied from interface: ReadOnlySortedSet

Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.

Specified by:

comparator in interface ReadOnlySortedSet<E>

Returns:

comparator or null

floor

public @Nullable E floor(E e)

Description copied from interface: ReadOnlyNavigableSet

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

Specified by:

floor in interface ReadOnlyNavigableSet<E>

Parameters:

e - the given element

Returns:

floor element or null

higher

public @Nullable E higher(E e)

Description copied from interface: ReadOnlyNavigableSet

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

Specified by:

higher in interface ReadOnlyNavigableSet<E>

Parameters:

e - the given element

Returns:

higher element or null

lower

public @Nullable E lower(E e)

Description copied from interface: ReadOnlyNavigableSet

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

Specified by:

lower in interface ReadOnlyNavigableSet<E>

Parameters:

e - the given element

Returns:

lower element or null

getFirst

public E getFirst()

Description copied from interface: ReadOnlySequencedCollection

Gets the first element.

Specified by:

getFirst in interface ReadOnlySequencedCollection<E>

Returns:

an element

getLast

public E getLast()

Description copied from interface: ReadOnlySequencedCollection

Gets the last element.

Specified by:

getLast in interface ReadOnlySequencedCollection<E>

Returns:

an element

readOnlyReversed

public @NonNull ReadOnlyNavigableSet<E> readOnlyReversed()

Description copied from interface: ReadOnlySequencedSet

Returns a reversed-order view of this set. Changes to the underlying set are visible in the reversed view.

Specified by:

readOnlyReversed in interface ReadOnlySequencedCollection<E>

Specified by:

readOnlyReversed in interface ReadOnlySequencedSet<E>

Returns:

a reversed-order view of this set