org.apache.ctakes.dictionary.lookup2.util.collection

Class EnumSetMap<K extends java.lang.Enum<K>,V>

java.lang.Object

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

All Implemented Interfaces:

java.lang.Iterable<java.util.Map.Entry<K,java.util.Set<V>>>, java.util.Map<K,java.util.Set<V>>, CollectionMap<K,V,java.util.Set<V>>

public final class EnumSetMap<K extends java.lang.Enum<K>,V>
extends java.lang.Object
implements CollectionMap<K,V,java.util.Set<V>>

Since:

9/23/2014

Nested Class Summary

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

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
private CollectionMap<K,V,java.util.Set<V>>	_delegate

Constructor Summary

Constructors

Constructor and Description
EnumSetMap(java.lang.Class<K> enumType)

Method Summary

Methods

Modifier and Type	Method and Description
<C extends java.util.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(java.lang.Object key)
boolean	containsValue(K key, V value) check the collection map for a key and value combination
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<K,java.util.Set<V>>>	entrySet()
java.util.Set<V>	get(java.lang.Object key)
java.util.Collection<java.util.Set<V>>	getAllCollections()
java.util.Set<V>	getCollection(K key) gets a collection mapped with key.
boolean	isEmpty()
java.util.Iterator<java.util.Map.Entry<K,java.util.Set<V>>>	iterator()
java.util.Set<K>	keySet()
java.util.Set<V>	obtainCollection(K key) obtains a collection mapped with key.
boolean	placeMap(java.util.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
java.util.Set<V>	put(K key, java.util.Set<V> value)
void	putAll(java.util.Map<? extends K,? extends java.util.Set<V>> map)
java.util.Set<V>	remove(java.lang.Object key)
void	removeValue(K key, V value) removes value from a collection mapped with key
int	size()
java.util.Map<K,java.util.Set<V>>	toSimpleMap() Copy of this object as a simple (java.util.Collection) map of Collection
java.util.Collection<java.util.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

equals, hashCode

Field Detail

_delegate

private final CollectionMap<K extends java.lang.Enum<K>,V,java.util.Set<V>> _delegate

Constructor Detail

EnumSetMap

public EnumSetMap(java.lang.Class<K> enumType)

Method Detail

iterator

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

Specified by:

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

getAllCollections

public java.util.Collection<java.util.Set<V>> getAllCollections()

Specified by:

getAllCollections in interface CollectionMap<K extends java.lang.Enum<K>,V,java.util.Set<V>>

Returns:

all of the collections for all keys

getCollection

public java.util.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 java.lang.Enum<K>,V,java.util.Set<V>>

Parameters:

key - key for internal collection

Returns:

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

obtainCollection

public java.util.Set<V> obtainCollection(K key)

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

Specified by:

obtainCollection in interface CollectionMap<K extends java.lang.Enum<K>,V,java.util.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 java.lang.Enum<K>,V,java.util.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 java.lang.Enum<K>,V,java.util.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(java.util.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 java.lang.Enum<K>,V,java.util.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 java.lang.Enum<K>,V,java.util.Set<V>>

Parameters:

key - key for internal collection

value - value to remove from internal collection

addAllValues

public <C extends java.util.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 java.lang.Enum<K>,V,java.util.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 java.lang.Enum<K>,V,java.util.Set<V>>

Parameters:

key - key for internal collection

size

public int size()

Specified by:

size in interface java.util.Map<K extends java.lang.Enum<K>,java.util.Set<V>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<K extends java.lang.Enum<K>,java.util.Set<V>>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<K extends java.lang.Enum<K>,java.util.Set<V>>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<K extends java.lang.Enum<K>,java.util.Set<V>>

get

public java.util.Set<V> get(java.lang.Object key)

Specified by:

get in interface java.util.Map<K extends java.lang.Enum<K>,java.util.Set<V>>

put

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

Specified by:

put in interface java.util.Map<K extends java.lang.Enum<K>,java.util.Set<V>>

remove

public java.util.Set<V> remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<K extends java.lang.Enum<K>,java.util.Set<V>>

putAll

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

Specified by:

putAll in interface java.util.Map<K extends java.lang.Enum<K>,java.util.Set<V>>

clear

public void clear()

Specified by:

clear in interface java.util.Map<K extends java.lang.Enum<K>,java.util.Set<V>>

keySet

public java.util.Set<K> keySet()

Specified by:

keySet in interface java.util.Map<K extends java.lang.Enum<K>,java.util.Set<V>>

values

public java.util.Collection<java.util.Set<V>> values()

Specified by:

values in interface java.util.Map<K extends java.lang.Enum<K>,java.util.Set<V>>

entrySet

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

Specified by:

entrySet in interface java.util.Map<K extends java.lang.Enum<K>,java.util.Set<V>>

toSimpleMap

public java.util.Map<K,java.util.Set<V>> toSimpleMap()

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

Specified by:

toSimpleMap in interface CollectionMap<K extends java.lang.Enum<K>,V,java.util.Set<V>>

Returns:

map of java.util.Collection