Package org.spongepowered.collections.inheritance

Class ArrayListMultimap<K,V>

java.lang.Object

org.spongepowered.collections.inheritance.ArrayListMultimap<K,V>

All Implemented Interfaces:

ListMultimap<K,V>, ListMultimap.Mutable<K,V>, Multimap<K,V>, Multimap.Mutable<K,V>

public final class ArrayListMultimap<K,V>
extends Object
implements ListMultimap.Mutable<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.collections.multimap.ListMultimap

ListMultimap.Mutable<K,V>

Nested classes/interfaces inherited from interface org.spongepowered.collections.multimap.Multimap

Multimap.Mutable<K,V>

Constructor Summary

Constructors

Constructor	Description
ArrayListMultimap()

Method Summary

Modifier and Type	Method	Description
List<V>	get(K key)	Gets the collection of paired values for the provided key.
boolean	isEmpty()
boolean	put(K key, V value)
Collection<V>	remove(K key)
int	size()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ArrayListMultimap

public ArrayListMultimap()

Method Details

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Multimap<K,V>

size

public int size()

Specified by:

size in interface Multimap<K,V>

get

public List<V> get(K key)

Description copied from interface: ListMultimap

Gets the collection of paired values for the provided key. It is expected that regardless whether a key has any valus matched, the returned collection is never null but possibly empty.

Unlike other possible implementations, this Collection returned is of a List. It is not guaranteed that the insertion order is retained, or that the provided list is sorted.

Specified by:

get in interface ListMultimap<K,V>

Specified by:

get in interface Multimap<K,V>

Parameters:

key - The key

Returns:

The collection of values

put

public boolean put(K key,
 V value)

Specified by:

put in interface Multimap.Mutable<K,V>

remove

public Collection<V> remove(K key)

Specified by:

remove in interface Multimap.Mutable<K,V>