org.semanticweb.elk.util.collections

Class AbstractHashMultimap<Key,Value>

java.lang.Object

java.util.AbstractMap<K,V>

org.semanticweb.elk.util.collections.ArrayHashMap<Key,Collection<Value>>

org.semanticweb.elk.util.collections.AbstractHashMultimap<Key,Value>

Type Parameters:

Key - the keys of the multimap

Value - the values of the multimap

All Implemented Interfaces:

Map<Key,Collection<Value>>, Multimap<Key,Value>

Direct Known Subclasses:

HashListMultimap, HashSetMultimap

public abstract class AbstractHashMultimap<Key,Value>
extends ArrayHashMap<Key,Collection<Value>>
implements Multimap<Key,Value>

Implementation of Multimap backed by an ArrayHashMap

Author:

Frantisek Simancik

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

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

Field Summary

Fields inherited from class org.semanticweb.elk.util.collections.ArrayHashMap

keys, size, values

Constructor Summary

Constructors

Constructor and Description
AbstractHashMultimap()
AbstractHashMultimap(int i)

Method Summary

Modifier and Type	Method and Description
boolean	add(Key key, Value value) Stores the key-value pair in this multimap
boolean	contains(Key key, Value value) Tests if the key-value pair occurs in this multimap
Collection<Value>	get(Object key) Returns the collection of values associated with the given key in this multimap
Collection<Value>	getValues(Object key)
protected abstract Collection<Value>	newRecord()
boolean	remove(Object key, Object value) Removes the key-value pair from this multimap

Methods inherited from class org.semanticweb.elk.util.collections.ArrayHashMap

clear, containsKey, containsValue, entrySet, isEmpty, keySet, put, remove, size, values

Methods inherited from class java.util.AbstractMap

clone, equals, hashCode, putAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.semanticweb.elk.util.collections.Multimap

clear, isEmpty, keySet, remove

Methods inherited from interface java.util.Map

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

Constructor Detail

AbstractHashMultimap

public AbstractHashMultimap()

AbstractHashMultimap

public AbstractHashMultimap(int i)

Method Detail

newRecord

protected abstract Collection<Value> newRecord()

contains

public boolean contains(Key key,
                        Value value)

Description copied from interface: Multimap

Tests if the key-value pair occurs in this multimap

Specified by:

contains in interface Multimap<Key,Value>

Parameters:

key - the key of the pair

value - the value of the pair

Returns:

true if this multimap contains the pair, false otherwise

add

public boolean add(Key key,
                   Value value)

Description copied from interface: Multimap

Stores the key-value pair in this multimap

Specified by:

add in interface Multimap<Key,Value>

Parameters:

key - the key of the pair

value - the value of the pair

Returns:

true if the multimap has changed as a result of the operation, false otherwise

get

public Collection<Value> get(Object key)

Description copied from interface: Multimap

Returns the collection of values associated with the given key in this multimap

Specified by:

get in interface Map<Key,Collection<Value>>

Specified by:

get in interface Multimap<Key,Value>

Overrides:

get in class ArrayHashMap<Key,Collection<Value>>

Parameters:

key - the key for which to retrieve the values

Returns:

the collection of values associated with the given key in this multimap

getValues

public Collection<Value> getValues(Object key)

Parameters:

key - the key for which to retrieve the associated values

Returns:

the collection of values associated with the given key, or null if no value us associated

remove

public boolean remove(Object key,
                      Object value)

Description copied from interface: Multimap

Removes the key-value pair from this multimap

Specified by:

remove in interface Map<Key,Collection<Value>>

Specified by:

remove in interface Multimap<Key,Value>

Parameters:

key - the key of the pair

value - the value of the pair

Returns:

true if the multimap has changed as a result of the operation, false otherwise