org.semanticweb.elk.util.collections

Class MultimapQueueImpl<Key,Value>

java.lang.Object

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

Type Parameters:

Key - the keys of the multimap

Value - the values of the multimap

All Implemented Interfaces:

Multimap<Key,Value>, MultimapQueue<Key,Value>

public class MultimapQueueImpl<Key,Value>
extends Object
implements MultimapQueue<Key,Value>

Simple MultimapQueue backed by a Multimap.

Author:

Pavel Klinov pavel.klinov@uni-ulm.de

Constructor Summary

Constructors

Constructor and Description
MultimapQueueImpl(Multimap<Key,Value> multimap)

Method Summary

Modifier and Type	Method and Description
boolean	add(Key key, Value value) Stores the key-value pair in this multimap
void	clear() Removes all key-value pairs of this multimap
boolean	contains(Key key, Value value) Tests if the key-value pair occurs in this multimap
Collection<Value>	get(Key key) Returns the collection of values associated with the given key in this multimap
boolean	isEmpty() Checks if this multimap is empty
Set<Key>	keySet()
Collection<Value>	remove(Object key) Removes all values for the given key
boolean	remove(Object key, Object value) Removes the key-value pair from this multimap
Map.Entry<Key,Collection<Value>>	takeEntry()

Methods inherited from class java.lang.Object

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

Constructor Detail

MultimapQueueImpl

public MultimapQueueImpl(Multimap<Key,Value> multimap)

Method Detail

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(Key key)

Description copied from interface: Multimap

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

Specified by:

get in interface Multimap<Key,Value>

Parameters:

key - the key for which to retrieve the values

Returns:

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

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 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

remove

public Collection<Value> remove(Object key)

Description copied from interface: Multimap

Removes all values for the given key

Specified by:

remove in interface Multimap<Key,Value>

Parameters:

key - the key for which to remove the values

Returns:

the values that have been removed

isEmpty

public boolean isEmpty()

Description copied from interface: Multimap

Checks if this multimap is empty

Specified by:

isEmpty in interface Multimap<Key,Value>

Returns:

true if this multimap is empty, false otherwise

keySet

public Set<Key> keySet()

Specified by:

keySet in interface Multimap<Key,Value>

clear

public void clear()

Description copied from interface: Multimap

Removes all key-value pairs of this multimap

Specified by:

clear in interface Multimap<Key,Value>

takeEntry

public Map.Entry<Key,Collection<Value>> takeEntry()

Specified by:

takeEntry in interface MultimapQueue<Key,Value>

Returns:

the removed entry or null if the queue is empty