org.rvpf.base.util.container

Interface ListMap<K,V>

Type Parameters:

K - The key type.

V - The value type.

All Superinterfaces:

Map<K,List<V>>

All Known Subinterfaces:

ListNavigableMap<K,V>

All Known Implementing Classes:

AbstractListNavigableMap, ListHashMap, ListLinkedHashMap, ListMap.Abstract, ListNavigableMap.Abstract, ListTreeMap

public interface ListMap<K,V>
extends Map<K,List<V>>

List map.

Extends a Map to allow multiple non null values for a single key.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ListMap.Abstract<K,V> Abstract list map.

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
void	add(K key, V value) Adds a value to a key.
List<V>	getAll(Object key) Gets all values for a key.
Optional<V>	getFirst(K key) Gets the first value for a key.
Optional<V>	getLast(K key) Gets the last value for a key.
void	put(K key) Puts an entry with an empty values list.
Optional<V>	removeFirst(K key) Removes the first value for a key.
Optional<V>	removeLast(K key) Removes the last value for a key.

Methods inherited from interface Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

add

void add(@Nonnull
         K key,
         @Nonnull
         V value)

Adds a value to a key.

Parameters:

key - The key.

value - The value.

getAll

@Nonnull
 @CheckReturnValue
List<V> getAll(@Nonnull
                                             Object key)

Gets all values for a key.

Parameters:

key - The key.

Returns:

A list of all values for the key.

getFirst

@Nonnull
 @CheckReturnValue
Optional<V> getFirst(@Nonnull
                                                   K key)

Gets the first value for a key.

Parameters:

key - The key.

Returns:

The optional first value for the key.

getLast

@Nonnull
 @CheckReturnValue
Optional<V> getLast(@Nonnull
                                                  K key)

Gets the last value for a key.

Parameters:

key - The key.

Returns:

The optional last value for the key.

put

void put(@Nonnull
         K key)

Puts an entry with an empty values list.

Parameters:

key - The key.

removeFirst

@Nonnull
Optional<V> removeFirst(@Nonnull
                                  K key)

Removes the first value for a key.

When the values list becomes empty, the entry is removed.

Parameters:

key - The key.

Returns:

The optional removed value.

removeLast

@Nonnull
Optional<V> removeLast(@Nonnull
                                 K key)

Removes the last value for a key.

When the values list becomes empty, the entry is removed.

Parameters:

key - The key.

Returns:

The optional removed value.