Package jadex.collection
Class MultiCollection<K,V>
java.lang.Object
jadex.collection.MultiCollection<K,V>
- All Implemented Interfaces:
Serializable
,Cloneable
,Map<K,
Collection<V>>
- Direct Known Subclasses:
TwoWayMultiCollection
public class MultiCollection<K,V>
extends Object
implements Map<K,Collection<V>>, Serializable, Cloneable
An MultiCollection is a map with the ability
to store more than one element per key (an collection).
- See Also:
-
Nested Class Summary
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreate a new multi collection.MultiCollection
(Map<K, Collection<V>> map, Class<?> type) Create a new multi collection. -
Method Summary
Modifier and TypeMethodDescriptionadd
(K key, Collection<V> value) Associates the specified value with the specified key in this map (optional operation).Associates the specified value with the specified key in this map (optional operation).void
Add all elements of another map.void
clear()
Removes all mappings from this map.clone()
Clone a multi collection.boolean
containsKey
(Object key) Returns true if this map contains a mapping for the specified key.boolean
containsValue
(Object value) Returns true if this map maps one or more keys to the specified value.createCollection
(K key) Create a collection instance.Set
<Map.Entry<K, Collection<V>>> entrySet()
Returns a set view of the mappings contained in this map.boolean
Compares the specified object with this map for equality.Returns the collection to which this map maps the specified key.getCollection
(Object key) Get the values associated to a key as collection.Object[]
getKeys()
Get the keys as array.Object[]
Get the keys as array.Get first object for a key (unwraps from collection).Object[]
Get the values as array.Object[]
getObjects
(Class<?> type) Get the values as array.int
hashCode()
Returns the hash code value for this map.boolean
isEmpty()
Returns true if this map contains no key-value mappings.keySet()
Returns a set view of the keys contained in this map.put
(K key, Collection<V> value) Associates the specified value with the specified key in this map (optional operation).void
putAll
(Map<? extends K, ? extends Collection<V>> t) Copies all of the mappings from the specified map to this map (optional operation).Removes the mapping for this key from this map if it is present.void
removeObject
(Object key, Object value) Remove a special object from the collection of a defined key.int
size()
Returns the number of elements added to this map.toString()
Create a string representation of this map.values()
Unsupported Operation.Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Field Details
-
map
The map. -
type
The collection type.
-
-
Constructor Details
-
MultiCollection
public MultiCollection()Create a new multi collection. -
MultiCollection
Create a new multi collection.- Parameters:
map
- The undelying map.type
- The collection type to use (requires public empty contstructor and has to implement java.util.Collection).
-
-
Method Details
-
clone
Clone a multi collection.- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
-
size
public int size()Returns the number of elements added to this map. -
isEmpty
public boolean isEmpty()Returns true if this map contains no key-value mappings. -
containsKey
Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains at a mapping for a key k such that (key==null ? k==null : key.equals(k)). (There can be at most one such mapping.) Be- Specified by:
containsKey
in interfaceMap<K,
V> - Parameters:
key
- key whose presence in this map is to be tested.- Returns:
- true if this map contains a mapping for the specified key.
- Throws:
ClassCastException
- if the key is of an inappropriate type for this map (optional).NullPointerException
- if the key is null and this map does not not permit null keys (optional).
-
containsValue
Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that (value==null ? v==null : value.equals(v)). This operation will probably require time linear in the map size for most implementations of the Map interface.- Specified by:
containsValue
in interfaceMap<K,
V> - Parameters:
value
- value whose presence in this map is to be tested.- Returns:
- true if this map maps one or more keys to the specified value.
- Throws:
ClassCastException
- if the value is of an inappropriate type for this map (optional).NullPointerException
- if the value is null and this map does not not permit null values (optional).
-
get
Returns the collection to which this map maps the specified key. Returns null if the map contains no mapping for this key.- Specified by:
get
in interfaceMap<K,
V> - Parameters:
key
- key whose associated collection is to be returned.- Returns:
- the collection to which this map maps the specified key, or null if the map contains no mapping for this key.
- Throws:
ClassCastException
- if the key is of an inappropriate type for this map (optional).NullPointerException
- key is null and this map does not not permit null keys (optional).- See Also:
-
getObject
Get first object for a key (unwraps from collection).- Parameters:
key
- The key.- Returns:
- The (first) value or null.
-
put
Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for this key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only ifm.containsKey(k)
would return true.))- Specified by:
put
in interfaceMap<K,
V> - Parameters:
key
- key with which the specified value is to be associated.value
- value to be associated with the specified key.- Returns:
- The collection associated to the key.
- Throws:
UnsupportedOperationException
- if the put operation is not supported by this map.ClassCastException
- if the class of the specified key or value prevents it from being stored in this map.IllegalArgumentException
- if some aspect of this key or value prevents it from being stored in this map.NullPointerException
- this map does not permit null keys or values, and the specified key or value is null.
-
add
Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for this key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only ifm.containsKey(k)
would return true.))- Parameters:
key
- key with which the specified value is to be associated.value
- value to be associated with the specified key.- Returns:
- The collection associated to the key.
- Throws:
UnsupportedOperationException
- if the put operation is not supported by this map.ClassCastException
- if the class of the specified key or value prevents it from being stored in this map.IllegalArgumentException
- if some aspect of this key or value prevents it from being stored in this map.NullPointerException
- this map does not permit null keys or values, and the specified key or value is null.
-
add
Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for this key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only ifm.containsKey(k)
would return true.))- Parameters:
key
- key with which the specified value is to be associated.value
- value to be associated with the specified key.- Returns:
- The collection associated to the key.
- Throws:
UnsupportedOperationException
- if the put operation is not supported by this map.ClassCastException
- if the class of the specified key or value prevents it from being stored in this map.IllegalArgumentException
- if some aspect of this key or value prevents it from being stored in this map.NullPointerException
- this map does not permit null keys or values, and the specified key or value is null.
-
addAll
Add all elements of another map.- Parameters:
t
- The other map.
-
putAll
Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of callingput(k, v)
on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is unspecified if the specified map is modified while the operation is in progress.- Specified by:
putAll
in interfaceMap<K,
V> - Parameters:
t
- Mappings to be stored in this map.- Throws:
UnsupportedOperationException
- if the putAll method is not supported by this map.ClassCastException
- if the class of a key or value in the specified map prevents it from being stored in this map.IllegalArgumentException
- some aspect of a key or value in the specified map prevents it from being stored in this map.NullPointerException
- the specified map is null, or if this map does not permit null keys or values, and the specified map contains null keys or values.
-
clear
public void clear()Removes all mappings from this map. -
keySet
Returns a set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress, the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll retainAll, and clear operations. It does not support the add or addAll operations. -
values
Unsupported Operation.- Specified by:
values
in interfaceMap<K,
V> - Throws:
UnsupportedOperationException
-
entrySet
Returns a set view of the mappings contained in this map. Each element in the returned set is a map entry. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress, the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations. -
equals
Compares the specified object with this map for equality. Returns true if the given object is also a map and the two Maps represent the same mappings. More formally, two maps t1 and t2 represent the same mappings if t1.entrySet().equals(t2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface. -
hashCode
public int hashCode()Returns the hash code value for this map. -
toString
Create a string representation of this map. -
remove
Removes the mapping for this key from this map if it is present. More formally, if this map contains a mapping from key k to value v such that(key==null ? k==null : key.equals(k))
, that mapping is removed. (The map can contain at most one such mapping.)Returns the value to which the map previously associated the key, or null if the map contained no mapping for this key. (A null return can also indicate that the map previously associated null with the specified key if the implementation supports null values.) The map will not contain a mapping for the specified key once the call returns.
- Specified by:
remove
in interfaceMap<K,
V> - Parameters:
key
- key whose mapping is to be removed from the map.- Returns:
- collection associated with specified key, or null if there was no mapping for key.
- Throws:
ClassCastException
- if the key is of an inappropriate type for this map (optional).NullPointerException
- if the key is null and this map does not not permit null keys (optional).
-
getCollection
Get the values associated to a key as collection.- Parameters:
key
- The key.- Returns:
- The collection of associated values.
-
getObjects
Get the values as array.- Returns:
- The array of values.
-
getObjects
Get the values as array.- Parameters:
type
- The component type of the array.- Returns:
- The array of values.
-
getKeys
Get the keys as array.- Returns:
- The array of keys.
-
getKeys
Get the keys as array.- Parameters:
type
- The component type of the array.- Returns:
- The array of keys.
-
removeObject
Remove a special object from the collection of a defined key. -
createCollection
Create a collection instance.
-