org.apache.ctakes.core.util.collection

Class EnumSetMap<K extends Enum<K>,V>

java.lang.Object

org.apache.ctakes.core.util.collection.EnumSetMap<K,V>

All Implemented Interfaces:

Iterable<Map.Entry<K,Set<V>>>, Map<K,Set<V>>, CollectionMap<K,V,Set<V>>

public final class EnumSetMap<K extends Enum<K>,V>
extends Object
implements CollectionMap<K,V,Set<V>>

Since:

9/23/2014

Version:

%I%

Author:

SPF , chip-nlp

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
EnumSetMap(Class<K> enumType)

Method Summary

Modifier and Type	Method and Description
<C extends Collection<V>> int	addAllValues(K key, C collection) adds everything from the given collection to the internal collection mapped with key
void	clear()
void	clearCollection(K key) clearCollection the collection mapped with key
boolean	containsKey(Object key)
boolean	containsValue(K key, V value) check the collection map for a key and value combination
boolean	containsValue(Object value)
Set<Map.Entry<K,Set<V>>>	entrySet()
Set<V>	get(Object key)
Collection<Set<V>>	getAllCollections()
Set<V>	getCollection(K key) gets a collection mapped with key.
Set<V>	getOrCreateCollection(K key) obtains a collection mapped with key.
boolean	isEmpty()
Iterator<Map.Entry<K,Set<V>>>	iterator()
Set<K>	keySet()
boolean	placeMap(Map<K,V> map) places each value of a map into a collection mapped with the appropriate key
boolean	placeValue(K key, V value) places value into a collection mapped with key
Set<V>	put(K key, Set<V> value)
void	putAll(Map<? extends K,? extends Set<V>> map)
Set<V>	remove(Object key)
void	removeValue(K key, V value) removes value from a collection mapped with key
int	size()
Map<K,Set<V>>	toSimpleMap() Copy of this object as a simple (java.util.Collection) map of Collection
Collection<Set<V>>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

EnumSetMap

public EnumSetMap(Class<K> enumType)

Method Detail

iterator

public Iterator<Map.Entry<K,Set<V>>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<K extends Enum<K>,Set<V>>>

getAllCollections

public Collection<Set<V>> getAllCollections()

Specified by:

getAllCollections in interface CollectionMap<K extends Enum<K>,V,Set<V>>

Returns:

all of the collections for all keys

getCollection

public Set<V> getCollection(K key)

gets a collection mapped with key. If one does not exist then an empty collection is returned

Specified by:

getCollection in interface CollectionMap<K extends Enum<K>,V,Set<V>>

Parameters:

key - key for internal collection

Returns:

collection mapped with key or an empty collection if there is none

getOrCreateCollection

public Set<V> getOrCreateCollection(K key)

obtains a collection mapped with key. If one does not exist then one is added to this CollectionMap

Specified by:

getOrCreateCollection in interface CollectionMap<K extends Enum<K>,V,Set<V>>

Parameters:

key - key for internal collection

Returns:

(possibly new) collection mapped with key

containsValue

public boolean containsValue(K key,
                             V value)

check the collection map for a key and value combination

Specified by:

containsValue in interface CollectionMap<K extends Enum<K>,V,Set<V>>

Parameters:

key - key for internal collection

value - value to check in internal collection

Returns:

true if this CollectionMap contain the value for the given key

placeValue

public boolean placeValue(K key,
                          V value)

places value into a collection mapped with key

Specified by:

placeValue in interface CollectionMap<K extends Enum<K>,V,Set<V>>

Parameters:

key - key for internal collection

value - value to placeValue in internal collection

Returns:

true if this set did not already contain the value

placeMap

public boolean placeMap(Map<K,V> map)

places each value of a map into a collection mapped with the appropriate key

Specified by:

placeMap in interface CollectionMap<K extends Enum<K>,V,Set<V>>

Parameters:

map - map to store

Returns:

true if this set did not already contain the value

removeValue

public void removeValue(K key,
                        V value)

removes value from a collection mapped with key

Specified by:

removeValue in interface CollectionMap<K extends Enum<K>,V,Set<V>>

Parameters:

key - key for internal collection

value - value to remove from internal collection

addAllValues

public <C extends Collection<V>> int addAllValues(K key,
                                                  C collection)

adds everything from the given collection to the internal collection mapped with key

Specified by:

addAllValues in interface CollectionMap<K extends Enum<K>,V,Set<V>>

Parameters:

key - key for internal collection

collection - collection of values to place in internal collection

Returns:

the number of new items added

clearCollection

public void clearCollection(K key)

clearCollection the collection mapped with key

Specified by:

clearCollection in interface CollectionMap<K extends Enum<K>,V,Set<V>>

Parameters:

key - key for internal collection

size

public int size()

Specified by:

size in interface Map<K extends Enum<K>,Set<V>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K extends Enum<K>,Set<V>>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K extends Enum<K>,Set<V>>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K extends Enum<K>,Set<V>>

get

public Set<V> get(Object key)

Specified by:

get in interface Map<K extends Enum<K>,Set<V>>

put

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

Specified by:

put in interface Map<K extends Enum<K>,Set<V>>

remove

public Set<V> remove(Object key)

Specified by:

remove in interface Map<K extends Enum<K>,Set<V>>

putAll

public void putAll(Map<? extends K,? extends Set<V>> map)

Specified by:

putAll in interface Map<K extends Enum<K>,Set<V>>

clear

public void clear()

Specified by:

clear in interface Map<K extends Enum<K>,Set<V>>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K extends Enum<K>,Set<V>>

values

public Collection<Set<V>> values()

Specified by:

values in interface Map<K extends Enum<K>,Set<V>>

entrySet

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

Specified by:

entrySet in interface Map<K extends Enum<K>,Set<V>>

toSimpleMap

public Map<K,Set<V>> toSimpleMap()

Copy of this object as a simple (java.util.Collection) map of Collection

Specified by:

toSimpleMap in interface CollectionMap<K extends Enum<K>,V,Set<V>>

Returns:

map of java.util.Collection