Module org.jhotdraw8.icollection

Package org.jhotdraw8.icollection.facade

Class ReadOnlySequencedMapFacade<K,V>

java.lang.Object

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

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

Type Parameters:

K - the key type

V - the value type

All Implemented Interfaces:

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

public class ReadOnlySequencedMapFacade<K,V>
extends ReadOnlyMapFacade<K,V>
implements ReadOnlySequencedMap<K,V>

Provides a ReadOnlySequencedMap facade to a set of ReadOnlySequencedMap functions.

Author:

Werner Randelshofer

Field Summary

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

containsKeyFunction, getFunction, iteratorFunction, sizeFunction

Constructor Summary

Constructors

Constructor	Description
ReadOnlySequencedMapFacade(@NonNull SequencedMap<K,V> target)
ReadOnlySequencedMapFacade(@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, int characteristics, @Nullable Comparator<? super K> comparator)

Method Summary

Modifier and Type	Method	Description
int	characteristics()	Returns the spliterator characteristics of the key set.
@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>	lastEntry()	Gets the last entry in this map or null if this map is empty.
@NonNull ReadOnlySequencedMap<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, spliterator

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

asMap, readOnlyEntrySet, readOnlyKeySet, readOnlyValues

Constructor Details

ReadOnlySequencedMapFacade

public ReadOnlySequencedMapFacade(@NonNull SequencedMap<K,V> target)

ReadOnlySequencedMapFacade

public ReadOnlySequencedMapFacade(@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,
 int characteristics,
 @Nullable Comparator<? super K> comparator)

Method Details

readOnlyReversed

public @NonNull ReadOnlySequencedMap<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

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>

Returns:

characteristics.