Module org.jhotdraw8.icollection

Package org.jhotdraw8.icollection.readonly

Interface ReadOnlySequencedMap<K,V>

Type Parameters:

K - the key type

V - the value type

All Superinterfaces:

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

All Known Subinterfaces:

ImmutableNavigableMap<K,V>, ImmutableSequencedMap<K,V>, ImmutableSortedMap<K,V>, ReadOnlyNavigableMap<K,V>, ReadOnlySortedMap<K,V>

All Known Implementing Classes:

ChampVectorMap, MutableChampVectorMap, MutableRedBlackMap, ReadOnlyNavigableMapFacade, ReadOnlySequencedMapFacade, ReadOnlySortedMapFacade, RedBlackMap

public interface ReadOnlySequencedMap<K,V>
extends ReadOnlyMap<K,V>

A read-only interface to a sequenced map. A sequenced map has a well-defined encounter order, that supports operations at both ends, and that is reversible.

References:

JEP draft: Sequenced Collections

java.ne

Method Summary

Modifier and Type	Method	Description
default @NonNull SequencedMap<K,V>	asMap()	Wraps this map in the Map interface - without copying.
default int	characteristics()	Returns the spliterator characteristics of the key set.
default @Nullable Map.Entry<K,V>	firstEntry()	Gets the first entry in this map or null if this map is empty.
default @Nullable Map.Entry<K,V>	lastEntry()	Gets the last entry in this map or null if this map is empty.
default @NonNull ReadOnlySequencedSet<Map.Entry<K,V>>	readOnlyEntrySet()	Returns a ReadOnlySequencedSet view of the entries contained in this map.
default @NonNull ReadOnlySequencedSet<K>	readOnlyKeySet()	Returns a ReadOnlySequencedSet view of the keys contained in this map.
@NonNull ReadOnlySequencedMap<K,V>	readOnlyReversed()	Returns a reversed-order view of this map.
default @NonNull ReadOnlySequencedCollection<V>	readOnlyValues()	Returns a ReadOnlySequencedCollection view of the values contained in this map.

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

Method Details

readOnlyReversed

@NonNull ReadOnlySequencedMap<K,V> readOnlyReversed()

Returns a reversed-order view of this map.

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

Returns:

a reversed-order view of this map

firstEntry

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

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

Returns:

the first entry or null

Throws:

NoSuchElementException - if the map is empty

lastEntry

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

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

Returns:

the last entry or null

Throws:

NoSuchElementException - if the map is empty

readOnlyEntrySet

default @NonNull ReadOnlySequencedSet<Map.Entry<K,V>> readOnlyEntrySet()

Returns a ReadOnlySequencedSet view of the entries contained in this map.

Specified by:

readOnlyEntrySet in interface ReadOnlyMap<K,V>

Returns:

a ReadOnlySequencedSet view of the entries

characteristics

default int characteristics()

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

Specified by:

characteristics in interface ReadOnlyMap<K,V>

Returns:

characteristics.

readOnlyKeySet

default @NonNull ReadOnlySequencedSet<K> readOnlyKeySet()

Returns a ReadOnlySequencedSet view of the keys contained in this map.

Specified by:

readOnlyKeySet in interface ReadOnlyMap<K,V>

Returns:

a ReadOnlySequencedSet view of the keys

readOnlyValues

default @NonNull ReadOnlySequencedCollection<V> readOnlyValues()

Returns a ReadOnlySequencedCollection view of the values contained in this map.

Specified by:

readOnlyValues in interface ReadOnlyMap<K,V>

Returns:

a ReadOnlySequencedCollection view of the values

asMap

default @NonNull SequencedMap<K,V> asMap()

Description copied from interface: ReadOnlyMap

Wraps this map in the Map interface - without copying.

Specified by:

asMap in interface ReadOnlyMap<K,V>

Returns:

the wrapped map