net.mdatools.modelant.core.util.map

Class MapToCollection<K,V>

java.lang.Object

net.mdatools.modelant.core.util.map.MapToCollection<K,V>

Type Parameters:

K - the class of the key

V - the class of the elements held in the collection

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MapToList, MapToSet

public abstract class MapToCollection<K,V>
extends Object
implements Serializable

Map each key to a collection of values

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MapToCollection()

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(K key)
protected abstract Collection<V>	createValuesCollection() This is a factory method for nested collections
Set<Map.Entry<K,Collection<V>>>	entrySet()
Collection<V>	get(K key)
boolean	isEmpty()
Set<K>	keySet()
Collection<V>	put(K key, Collection<V> value)
Collection<V>	put(K key, V value)
void	putAll(MapToCollection<K,V> t)
Collection<V>	remove(K key) Removes the whole collection bound to the key
boolean	remove(K key, V value) Removes the value from the collection for that key
Map<K,Collection<V>>	toMap()
String	toString()
Collection<V>	values()

Methods inherited from class java.lang.Object

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

Constructor Detail

MapToCollection

public MapToCollection()

Method Detail

clear

public final void clear()

See Also:

Map.clear()

containsKey

public final boolean containsKey(K key)

See Also:

Map.containsKey(java.lang.Object)

get

public Collection<V> get(K key)

Parameters:

key -

Returns:

null or a a non-empty list of values

See Also:

Map.get(java.lang.Object)

isEmpty

public final boolean isEmpty()

See Also:

Map.isEmpty()

keySet

public final Set<K> keySet()

See Also:

Map.keySet()

entrySet

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

See Also:

Map.keySet()

put

public final Collection<V> put(K key,
                               V value)

Returns:

the list of all actual mappings bound to this key. NOTE: this is different than the the inherited specification, where the previous value bound to the key is required to be returned

See Also:

Map.put(java.lang.Object, java.lang.Object)

put

public final Collection<V> put(K key,
                               Collection<V> value)

putAll

public final void putAll(MapToCollection<K,V> t)

See Also:

Map.putAll(java.util.Map)

remove

public final Collection<V> remove(K key)

Removes the whole collection bound to the key

Returns:

the original values collection bound to that key

See Also:

Map.remove(java.lang.Object)

remove

public final boolean remove(K key,
                            V value)

Removes the value from the collection for that key

Returns:

true if actually removed the value

See Also:

Map.remove(java.lang.Object)

values

public final Collection<V> values()

Returns:

a collection of all values in this multi-value map

See Also:

Map.values()

createValuesCollection

protected abstract Collection<V> createValuesCollection()

This is a factory method for nested collections

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

toMap

public final Map<K,Collection<V>> toMap()

Returns:

convert this to a read-only map to collections