Added in API level 35

Summary: Methods | Inherited Methods

SequencedMap

public interface SequencedMap
implements Map<K, V>

java.util.SequencedMap<K, V>

Known indirect subclasses

ConcurrentNavigableMap<K, V>, ConcurrentSkipListMap<K, V>, LinkedHashMap<K, V>, NavigableMap<K, V>, SortedMap<K, V>, TreeMap<K, V>

ConcurrentNavigableMap<K, V>	A `ConcurrentMap` supporting `NavigableMap` operations, and recursively so for its navigable sub-maps.
ConcurrentSkipListMap<K, V>	A scalable concurrent `ConcurrentNavigableMap` implementation.
LinkedHashMap<K, V>	Hash table and linked list implementation of the `Map` interface, with well-defined encounter order.
NavigableMap<K, V>	A `SortedMap` extended with navigation methods returning the closest matches for given search targets.
SortedMap<K, V>	A `Map` that further provides a total ordering on its keys.
TreeMap<K, V>	A Red-Black tree based `NavigableMap` implementation.

A Map that has a well-defined encounter order, that supports operations at both ends, and that is reversible. The encounter order of a SequencedMap is similar to that of the elements of a SequencedCollection, but the ordering applies to mappings instead of individual elements.

The bulk operations on this map, including the forEach and the replaceAll methods, operate on this map's mappings in encounter order.

The view collections provided by the keySet, values, entrySet, sequencedKeySet, sequencedValues, and sequencedEntrySet methods all reflect the encounter order of this map. Even though the return values of the keySet, values, and entrySet methods are not sequenced types, the elements in those view collections do reflect the encounter order of this map. Thus, the iterators returned by the statements : var it1 = sequencedMap.entrySet().iterator(); var it2 = sequencedMap.sequencedEntrySet().iterator(); both provide the mappings of sequencedMap in that map's encounter order.

This interface provides methods to add mappings, to retrieve mappings, and to remove mappings at either end of the map's encounter order.

This interface also defines the reversed() method, which provides a reverse-ordered view of this map. In the reverse-ordered view, the concepts of first and last are inverted, as are the concepts of successor and predecessor. The first mapping of this map is the last mapping of the reverse-ordered view, and vice-versa. The successor of some mapping in this map is its predecessor in the reversed view, and vice-versa. All methods that respect the encounter order of the map operate as if the encounter order is inverted. For instance, the forEach method of the reversed view reports the mappings in order from the last mapping of this map to the first. In addition, all of the view collections of the reversed view also reflect the inverse of this map's encounter order. For example, : var itr = sequencedMap.reversed().entrySet().iterator(); provides the mappings of this map in the inverse of the encounter order, that is, from the last mapping to the first mapping. The availability of the reversed method, and its impact on the ordering semantics of all applicable methods and views, allow convenient iteration, searching, copying, and streaming of this map's mappings in either forward order or reverse order.

A map's reverse-ordered view is generally not serializable, even if the original map is serializable.

The Map.Entry instances obtained by iterating the Map.entrySet() view, the sequencedEntrySet() view, and its reverse-ordered view, maintain a connection to the underlying map. This connection is guaranteed only during the iteration. It is unspecified whether the connection is maintained outside of the iteration. If the underlying map permits it, calling an Entry's setValue method will modify the value of the underlying mapping. It is, however, unspecified whether modifications to the value in the underlying mapping are visible in the Entry instance.

The methods firstEntry(), lastEntry(), pollFirstEntry(), and pollLastEntry() return Map.Entry instances that represent snapshots of mappings as of the time of the call. They do not support mutation of the underlying map via the optional setValue method.

Depending upon the implementation, the Entry instances returned by other means might or might not be connected to the underlying map. For example, consider an Entry obtained in the following manner: : var entry = sequencedMap.sequencedEntrySet().getFirst(); It is not specified by this interface whether the setValue method of the Entry thus obtained will update a mapping in the underlying map, or whether it will throw an exception, or whether changes to the underlying map are visible in that Entry.

This interface has the same requirements on the equals and hashCode methods as defined by Map.equals and Map.hashCode. Thus, a Map and a SequencedMap will compare equals if and only if they have equal mappings, irrespective of ordering.

This class is a member of the Java Collections Framework.

Summary

Public methods
`default Entry<K, V>`	`firstEntry()` Returns the first key-value mapping in this map, or `null` if the map is empty.
`default Entry<K, V>`	`lastEntry()` Returns the last key-value mapping in this map, or `null` if the map is empty.
`default Entry<K, V>`	`pollFirstEntry()` Removes and returns the first key-value mapping in this map, or `null` if the map is empty (optional operation).
`default Entry<K, V>`	`pollLastEntry()` Removes and returns the last key-value mapping in this map, or `null` if the map is empty (optional operation).
`default V`	`putFirst(K k, V v)` Inserts the given mapping into the map if it is not already present, or replaces the value of a mapping if it is already present (optional operation).
`default V`	`putLast(K k, V v)` Inserts the given mapping into the map if it is not already present, or replaces the value of a mapping if it is already present (optional operation).
`abstract SequencedMap<K, V>`	`reversed()` Returns a reverse-ordered view of this map.
`default SequencedSet<Entry<K, V>>`	`sequencedEntrySet()` Returns a `SequencedSet` view of this map's `entrySet`.
`default SequencedSet<K>`	`sequencedKeySet()` Returns a `SequencedSet` view of this map's `keySet`.
`default SequencedCollection<V>`	`sequencedValues()` Returns a `SequencedCollection` view of this map's `values` collection.

Inherited methods

From interface


        
          java.util.Map

`abstract void`	`clear()` Removes all of the mappings from this map (optional operation).
`default V`	`compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)` Attempts to compute a mapping for the specified key and its current mapped value (or `null` if there is no current mapping).
`default V`	`computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction)` If the specified key is not already associated with a value (or is mapped to `null`), attempts to compute its value using the given mapping function and enters it into this map unless `null`.
`default V`	`computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)` If the value for the specified key is present and non-null, attempts to compute a new mapping given the key and its current mapped value.
`abstract boolean`	`containsKey(Object key)` Returns `true` if this map contains a mapping for the specified key.
`abstract boolean`	`containsValue(Object value)` Returns `true` if this map maps one or more keys to the specified value.
`static <K, V> Map<K, V>`	`copyOf(Map<? extends K, ? extends V> map)` Returns an unmodifiable Map containing the entries of the given Map.
`static <K, V> Entry<K, V>`	`entry(K k, V v)` Returns an unmodifiable `Entry` containing the given key and value.
`abstract Set<Entry<K, V>>`	`entrySet()` Returns a `Set` view of the mappings contained in this map.
`abstract boolean`	`equals(Object o)` Compares the specified object with this map for equality.
`default void`	`forEach(BiConsumer<? super K, ? super V> action)` Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.
`abstract V`	`get(Object key)` Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
`default V`	`getOrDefault(Object key, V defaultValue)` Returns the value to which the specified key is mapped, or `defaultValue` if this map contains no mapping for the key.
`abstract int`	`hashCode()` Returns the hash code value for this map.
`abstract boolean`	`isEmpty()` Returns `true` if this map contains no key-value mappings.
`abstract Set<K>`	`keySet()` Returns a `Set` view of the keys contained in this map.
`default V`	`merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction)` If the specified key is not already associated with a value or is associated with null, associates it with the given non-null value.
`static <K, V> Map<K, V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)` Returns an unmodifiable map containing five mappings.
`static <K, V> Map<K, V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)` Returns an unmodifiable map containing four mappings.
`static <K, V> Map<K, V>`	`of(K k1, V v1)` Returns an unmodifiable map containing a single mapping.
`static <K, V> Map<K, V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8)` Returns an unmodifiable map containing eight mappings.
`static <K, V> Map<K, V>`	`of(K k1, V v1, K k2, V v2)` Returns an unmodifiable map containing two mappings.
`static <K, V> Map<K, V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3)` Returns an unmodifiable map containing three mappings.
`static <K, V> Map<K, V>`	`of()` Returns an unmodifiable map containing zero mappings.
`static <K, V> Map<K, V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9)` Returns an unmodifiable map containing nine mappings.
`static <K, V> Map<K, V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6)` Returns an unmodifiable map containing six mappings.
`static <K, V> Map<K, V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7)` Returns an unmodifiable map containing seven mappings.
`static <K, V> Map<K, V>`	`of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9, K k10, V v10)` Returns an unmodifiable map containing ten mappings.
`static <K, V> Map<K, V>`	`ofEntries(Entry...<? extends K, ? extends V> entries)` Returns an unmodifiable map containing keys and values extracted from the given entries.
`abstract V`	`put(K key, V value)` Associates the specified value with the specified key in this map (optional operation).
`abstract void`	`putAll(Map<? extends K, ? extends V> m)` Copies all of the mappings from the specified map to this map (optional operation).
`default V`	`putIfAbsent(K key, V value)` If the specified key is not already associated with a value (or is mapped to `null`) associates it with the given value and returns `null`, else returns the current value.
`default boolean`	`remove(Object key, Object value)` Removes the entry for the specified key only if it is currently mapped to the specified value.
`abstract V`	`remove(Object key)` Removes the mapping for a key from this map if it is present (optional operation).
`default boolean`	`replace(K key, V oldValue, V newValue)` Replaces the entry for the specified key only if currently mapped to the specified value.
`default V`	`replace(K key, V value)` Replaces the entry for the specified key only if it is currently mapped to some value.
`default void`	`replaceAll(BiFunction<? super K, ? super V, ? extends V> function)` Replaces each entry's value with the result of invoking the given function on that entry until all entries have been processed or the function throws an exception.
`abstract int`	`size()` Returns the number of key-value mappings in this map.
`abstract Collection<V>`	`values()` Returns a `Collection` view of the values contained in this map.

Public methods

firstEntry

Added in API level 35

public Entry<K, V> firstEntry ()

Returns the first key-value mapping in this map, or null if the map is empty.

Implementation Requirements:

The implementation in this interface obtains the iterator of this map's entrySet. If the iterator has an element, it returns an unmodifiable copy of that element. Otherwise, it returns null.

Returns
`Entry<K, V>`	the first key-value mapping, or `null` if this map is empty

lastEntry

Added in API level 35

public Entry<K, V> lastEntry ()

Returns the last key-value mapping in this map, or null if the map is empty.

Implementation Requirements:

The implementation in this interface obtains the iterator of the entrySet of this map's reversed view. If the iterator has an element, it returns an unmodifiable copy of that element. Otherwise, it returns null.

Returns
`Entry<K, V>`	the last key-value mapping, or `null` if this map is empty

pollFirstEntry

Added in API level 35

public Entry<K, V> pollFirstEntry ()

Removes and returns the first key-value mapping in this map, or null if the map is empty (optional operation).

Implementation Requirements:

The implementation in this interface obtains the iterator of this map's entrySet. If the iterator has an element, it calls remove on the iterator and then returns an unmodifiable copy of that element. Otherwise, it returns null.

Returns
`Entry<K, V>`	the removed first entry of this map, or `null` if this map is empty

Throws
`UnsupportedOperationException`	if this collection implementation does not support this operation

pollLastEntry

Added in API level 35

public Entry<K, V> pollLastEntry ()

Removes and returns the last key-value mapping in this map, or null if the map is empty (optional operation).

Implementation Requirements:

The implementation in this interface obtains the iterator of the entrySet of this map's reversed view. If the iterator has an element, it calls remove on the iterator and then returns an unmodifiable copy of that element. Otherwise, it returns null.

Returns
`Entry<K, V>`	the removed last entry of this map, or `null` if this map is empty

Throws
`UnsupportedOperationException`	if this collection implementation does not support this operation

putFirst

Added in API level 35

public V putFirst (K k, 
                V v)

Inserts the given mapping into the map if it is not already present, or replaces the value of a mapping if it is already present (optional operation). After this operation completes normally, the given mapping will be present in this map, and it will be the first mapping in this map's encounter order.

Implementation Requirements:

The implementation in this interface always throws UnsupportedOperationException.

Parameters
`k`	`K`: the key
`v`	`V`: the value

Returns
`V`	the value previously associated with k, or null if none

Throws
`UnsupportedOperationException`	if this collection implementation does not support this operation

putLast

Added in API level 35

public V putLast (K k, 
                V v)

Implementation Requirements:

The implementation in this interface always throws UnsupportedOperationException.

Parameters
`k`	`K`: the key
`v`	`V`: the value

Returns
`V`	the value previously associated with k, or null if none

Throws
`UnsupportedOperationException`	if this collection implementation does not support this operation

reversed

Added in API level 35

public abstract SequencedMap<K, V> reversed ()

Returns a reverse-ordered view of this map. The encounter order of mappings in the returned view is the inverse of the encounter order of mappings in this map. The reverse ordering affects all order-sensitive operations, including those on the view collections of the returned view. If the implementation permits modifications to this view, the modifications "write through" to the underlying map. Changes to the underlying map might or might not be visible in this reversed view, depending upon the implementation.

Returns
`SequencedMap<K, V>`	a reverse-ordered view of this map

sequencedEntrySet

Added in API level 35

public SequencedSet<Entry<K, V>> sequencedEntrySet ()

Returns a SequencedSet view of this map's entrySet.

Implementation Requirements:

The implementation in this interface returns a SequencedSet instance that behaves as follows. Its add and addAll methods throw UnsupportedOperationException. Its reversed method returns the sequencedEntrySet view of the reversed view of this map. Each of its other methods calls the corresponding method of the entrySet view of this map.

Returns
`SequencedSet<Entry<K, V>>`	a `SequencedSet` view of this map's `entrySet`

sequencedKeySet

Added in API level 35

public SequencedSet<K> sequencedKeySet ()

Returns a SequencedSet view of this map's keySet.

Implementation Requirements:

The implementation in this interface returns a SequencedSet instance that behaves as follows. Its add and addAll methods throw UnsupportedOperationException. Its reversed method returns the sequencedKeySet view of the reversed view of this map. Each of its other methods calls the corresponding method of the keySet view of this map.

Returns
`SequencedSet<K>`	a `SequencedSet` view of this map's `keySet`

sequencedValues

Added in API level 35

public SequencedCollection<V> sequencedValues ()

Returns a SequencedCollection view of this map's values collection.

Implementation Requirements:

The implementation in this interface returns a SequencedCollection instance that behaves as follows. Its add and addAll methods throw UnsupportedOperationException. Its reversed method returns the sequencedValues view of the reversed view of this map. Its equals and hashCode methods are inherited from Object. Each of its other methods calls the corresponding method of the values view of this map.

Returns
`SequencedCollection<V>`	a `SequencedCollection` view of this map's `values` collection