org.rvpf.base.util.container

Class ListMap.Abstract<K,V>

Object

AbstractMap<K,List<V>>

ListMap.Abstract<K,V>

Type Parameters:

K - The key type.

V - The value type.

All Implemented Interfaces:

Serializable, Cloneable, Map<K,List<V>>, ListMap<K,V>

Direct Known Subclasses:

AbstractListNavigableMap, ListHashMap, ListLinkedHashMap, ListNavigableMap.Abstract

Enclosing interface:

ListMap<K,V>

@NotThreadSafe
public abstract static class ListMap.Abstract<K,V>
extends AbstractMap<K,List<V>>
implements ListMap<K,V>, Cloneable, Serializable

Abstract list map.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface ListMap

ListMap.Abstract<K,V>

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Abstract(Map<K,List<V>> map) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	add(K key, V value) Adds a value to a key.
void	clear()
ListMap<K,V>	clone()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<K,List<V>>>	entrySet()
List<V>	get(Object 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.
boolean	isEmpty()
Set<K>	keySet()
protected void	mapReplaced(Map<K,List<V>> map) Called when the Map is replaced.
void	put(K key) Puts an entry with an empty values list.
List<V>	put(K key, List<V> value)
List<V>	remove(Object key)
Optional<V>	removeFirst(K key) Removes the first value for a key.
Optional<V>	removeLast(K key) Removes the last value for a key.
int	size()
Collection<List<V>>	values()

Methods inherited from class AbstractMap

equals, hashCode, putAll, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putAll, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Abstract

protected Abstract(@Nonnull
                   Map<K,List<V>> map)

Constructs an instance.

Parameters:

map - The map implementation.

Method Detail

add

public void add(K key,
                V value)

Adds a value to a key.

Specified by:

add in interface ListMap<K,V>

Parameters:

key - The key.

value - The value.

clear

public void clear()

Specified by:

clear in interface Map<K,List<V>>

Overrides:

clear in class AbstractMap<K,List<V>>

clone

public ListMap<K,V> clone()

Overrides:

clone in class AbstractMap<K,List<V>>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,List<V>>

Overrides:

containsKey in class AbstractMap<K,List<V>>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,List<V>>

Overrides:

containsValue in class AbstractMap<K,List<V>>

entrySet

public Set<Map.Entry<K,List<V>>> entrySet()

Specified by:

entrySet in interface Map<K,List<V>>

Specified by:

entrySet in class AbstractMap<K,List<V>>

get

public List<V> get(Object key)

Specified by:

get in interface Map<K,List<V>>

Overrides:

get in class AbstractMap<K,List<V>>

getAll

public List<V> getAll(Object key)

Gets all values for a key.

Specified by:

getAll in interface ListMap<K,V>

Parameters:

key - The key.

Returns:

A list of all values for the key.

getFirst

public Optional<V> getFirst(K key)

Gets the first value for a key.

Specified by:

getFirst in interface ListMap<K,V>

Parameters:

key - The key.

Returns:

The optional first value for the key.

getLast

public Optional<V> getLast(K key)

Gets the last value for a key.

Specified by:

getLast in interface ListMap<K,V>

Parameters:

key - The key.

Returns:

The optional last value for the key.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,List<V>>

Overrides:

isEmpty in class AbstractMap<K,List<V>>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,List<V>>

Overrides:

keySet in class AbstractMap<K,List<V>>

put

public void put(K key)

Puts an entry with an empty values list.

Specified by:

put in interface ListMap<K,V>

Parameters:

key - The key.

put

public List<V> put(K key,
                   List<V> value)

Specified by:

put in interface Map<K,List<V>>

Overrides:

put in class AbstractMap<K,List<V>>

remove

public List<V> remove(Object key)

Specified by:

remove in interface Map<K,List<V>>

Overrides:

remove in class AbstractMap<K,List<V>>

removeFirst

public Optional<V> removeFirst(K key)

Removes the first value for a key.

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

Specified by:

removeFirst in interface ListMap<K,V>

Parameters:

key - The key.

Returns:

The optional removed value.

removeLast

public Optional<V> removeLast(K key)

Removes the last value for a key.

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

Specified by:

removeLast in interface ListMap<K,V>

Parameters:

key - The key.

Returns:

The optional removed value.

size

public int size()

Specified by:

size in interface Map<K,List<V>>

Overrides:

size in class AbstractMap<K,List<V>>

values

public Collection<List<V>> values()

Specified by:

values in interface Map<K,List<V>>

Overrides:

values in class AbstractMap<K,List<V>>

mapReplaced

protected void mapReplaced(@Nonnull
                           Map<K,List<V>> map)

Called when the Map is replaced.

This may be overridden by subclass as needed.

Parameters:

map - The Map.