Module org.jhotdraw8.icollection

Package org.jhotdraw8.icollection.facade

Class ReadOnlyNavigableMapFacade<K,V>

java.lang.Object

org.jhotdraw8.icollection.facade.ReadOnlyMapFacade<K,V>

org.jhotdraw8.icollection.facade.ReadOnlyNavigableMapFacade<K,V>

Type Parameters:

K - the key type

V - the value type

All Implemented Interfaces:

Iterable<Map.Entry<K,V>>, ReadOnlyMap<K,V>, ReadOnlyNavigableMap<K,V>, ReadOnlySequencedMap<K,V>, ReadOnlySortedMap<K,V>

public class ReadOnlyNavigableMapFacade<K,V>
extends ReadOnlyMapFacade<K,V>
implements ReadOnlyNavigableMap<K,V>

Provides a ReadOnlyNavigableMap facade to a set of ReadOnlyNavigableMap functions.

Author:

Werner Randelshofer

Field Summary

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

containsKeyFunction, getFunction, iteratorFunction, sizeFunction

Constructor Summary

Constructors

Constructor	Description
ReadOnlyNavigableMapFacade(@NonNull NavigableMap<K,V> target)
ReadOnlyNavigableMapFacade(@NonNull Supplier<Iterator<Map.Entry<K,V>>> iteratorFunction, @NonNull Supplier<Iterator<Map.Entry<K,V>>> reverseIteratorFunction, @NonNull IntSupplier sizeFunction, @NonNull Predicate<Object> containsKeyFunction, @NonNull Function<K,V> getFunction, @NonNull Supplier<Map.Entry<K,V>> firstEntryFunction, @NonNull Supplier<Map.Entry<K,V>> lastEntryFunction, @NonNull Function<K,Map.Entry<K,V>> ceilingFunction, @NonNull Function<K,Map.Entry<K,V>> floorFunction, @NonNull Function<K,Map.Entry<K,V>> higherFunction, @NonNull Function<K,Map.Entry<K,V>> lowerFunction, int characteristics, @Nullable Supplier<Comparator<? super K>> comparator)

Method Summary

Modifier and Type	Method	Description
@Nullable Map.Entry<K,V>	ceilingEntry(K k)	Returns the least entry in this map with a key greater than or equal to the given key, or null if there is no such entry.
int	characteristics()	Returns the spliterator characteristics of the key set.
@Nullable Comparator<? super K>	comparator()	Returns the comparator used to order the keys in this map, or null if this set uses the natural ordering of its keys.
@Nullable Map.Entry<K,V>	firstEntry()	Gets the first entry in this map or null if this map is empty.
@Nullable Map.Entry<K,V>	floorEntry(K k)	Returns the greatest entry in this map with a key less than or equal to the given key, or null if there is no such entry.
@Nullable Map.Entry<K,V>	higherEntry(K k)	Returns the least entry in this map with a key greater than the given key, or null if there is no such entry.
@Nullable Map.Entry<K,V>	lastEntry()	Gets the last entry in this map or null if this map is empty.
@Nullable Map.Entry<K,V>	lowerEntry(K k)	Returns the greatest entry in this map with a key less than the given key, or null if there is no such entry.
@NonNull ReadOnlyNavigableMap<K,V>	readOnlyReversed()	Returns a reversed-order view of this map.

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

containsEntry, containsKey, get, isEmpty, iterator, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach

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

containsEntry, containsKey, containsValue, equals, get, getOrDefault, hashCode, isEmpty, iterator, size

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

ceilingKey, floorKey, higherKey, lowerKey

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

asMap, readOnlyEntrySet, readOnlyKeySet, readOnlyValues

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

spliterator

Constructor Details

ReadOnlyNavigableMapFacade

public ReadOnlyNavigableMapFacade(@NonNull NavigableMap<K,V> target)

ReadOnlyNavigableMapFacade

public ReadOnlyNavigableMapFacade(@NonNull Supplier<Iterator<Map.Entry<K,V>>> iteratorFunction,
 @NonNull Supplier<Iterator<Map.Entry<K,V>>> reverseIteratorFunction,
 @NonNull IntSupplier sizeFunction,
 @NonNull Predicate<Object> containsKeyFunction,
 @NonNull Function<K,V> getFunction,
 @NonNull Supplier<Map.Entry<K,V>> firstEntryFunction,
 @NonNull Supplier<Map.Entry<K,V>> lastEntryFunction,
 @NonNull Function<K,Map.Entry<K,V>> ceilingFunction,
 @NonNull Function<K,Map.Entry<K,V>> floorFunction,
 @NonNull Function<K,Map.Entry<K,V>> higherFunction,
 @NonNull Function<K,Map.Entry<K,V>> lowerFunction,
 int characteristics,
 @Nullable Supplier<Comparator<? super K>> comparator)

Method Details

ceilingEntry

public @Nullable Map.Entry<K,V> ceilingEntry(K k)

Description copied from interface: ReadOnlyNavigableMap

Returns the least entry in this map with a key greater than or equal to the given key, or null if there is no such entry.

Specified by:

ceilingEntry in interface ReadOnlyNavigableMap<K,V>

Parameters:

k - the given key

Returns:

ceiling entry or null

floorEntry

public @Nullable Map.Entry<K,V> floorEntry(K k)

Description copied from interface: ReadOnlyNavigableMap

Returns the greatest entry in this map with a key less than or equal to the given key, or null if there is no such entry.

Specified by:

floorEntry in interface ReadOnlyNavigableMap<K,V>

Parameters:

k - the given key

Returns:

floor entry or null

higherEntry

public @Nullable Map.Entry<K,V> higherEntry(K k)

Description copied from interface: ReadOnlyNavigableMap

Returns the least entry in this map with a key greater than the given key, or null if there is no such entry.

Specified by:

higherEntry in interface ReadOnlyNavigableMap<K,V>

Parameters:

k - the given key

Returns:

higher entry or null

lowerEntry

public @Nullable Map.Entry<K,V> lowerEntry(K k)

Description copied from interface: ReadOnlyNavigableMap

Returns the greatest entry in this map with a key less than the given key, or null if there is no such entry.

Specified by:

lowerEntry in interface ReadOnlyNavigableMap<K,V>

Parameters:

k - the given key

Returns:

lower entry or null

readOnlyReversed

public @NonNull ReadOnlyNavigableMap<K,V> readOnlyReversed()

Description copied from interface: ReadOnlySequencedMap

Returns a reversed-order view of this map.

Changes to the underlying map are visible in the reversed view.

Specified by:

readOnlyReversed in interface ReadOnlySequencedMap<K,V>

Returns:

a reversed-order view of this map

firstEntry

public @Nullable Map.Entry<K,V> firstEntry()

Description copied from interface: ReadOnlySequencedMap

Gets the first entry in this map or null if this map is empty.

Specified by:

firstEntry in interface ReadOnlySequencedMap<K,V>

Returns:

the first entry or null

lastEntry

public @Nullable Map.Entry<K,V> lastEntry()

Description copied from interface: ReadOnlySequencedMap

Gets the last entry in this map or null if this map is empty.

Specified by:

lastEntry in interface ReadOnlySequencedMap<K,V>

Returns:

the last entry or null

comparator

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

Description copied from interface: ReadOnlySortedMap

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

Specified by:

comparator in interface ReadOnlySortedMap<K,V>

Returns:

comparator or null

characteristics

public int characteristics()

Description copied from interface: ReadOnlySequencedMap

Returns the spliterator characteristics of the key set. This implementation returns Spliterator.SIZED|Spliterator.DISTINCT.

Specified by:

characteristics in interface ReadOnlyMap<K,V>

Specified by:

characteristics in interface ReadOnlySequencedMap<K,V>

Specified by:

characteristics in interface ReadOnlySortedMap<K,V>

Returns:

characteristics.