|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--harpoon.Util.Collections.GenericInvertibleMultiMap
GenericInvertibleMultiMap
is a default implementation of
InvertibleMultiMap
. It returns modifiable inverted
views of the mappings it maintains. Note that a
GenericInvertibleMultiMap
can directly replace a
GenericInvertibleMap
, because MultiMap
correctly extends Map
.
Nested Class Summary |
Nested classes inherited from class harpoon.Util.Collections.MultiMap |
MultiMap.Factory |
Nested classes inherited from class java.util.Map |
Map.Entry |
Constructor Summary | |
GenericInvertibleMultiMap()
|
|
GenericInvertibleMultiMap(CollectionFactory cf)
|
|
GenericInvertibleMultiMap(Map m)
|
|
GenericInvertibleMultiMap(MapFactory mf,
CollectionFactory cf)
|
|
GenericInvertibleMultiMap(MultiMap.Factory mmf)
|
|
GenericInvertibleMultiMap(MultiMap mm)
|
Method Summary | |
boolean |
add(Object key,
Object value)
Ensures that this contains an association from
key to value . |
boolean |
addAll(MultiMap mm)
Adds all mappings in the given multimap to this multimap. |
boolean |
addAll(Object key,
Collection values)
Adds to the current mappings: associations for key to each value in values . |
void |
clear()
|
boolean |
contains(Object a,
Object b)
Returns true if a has a mapping to b
in this . |
boolean |
containsKey(Object key)
|
boolean |
containsValue(Object value)
|
Set |
entrySet()
The Set returned by this method is actually an
instance of MultiMapSet . |
boolean |
equals(Object o)
|
Object |
get(Object key)
Returns some arbitrary value from the collection of values to which this map maps the specified key. |
Collection |
getValues(Object key)
Returns the collection of Values associated with key . |
int |
hashCode()
|
InvertibleMultiMap |
invert()
Returns an unmodifiable inverted view of this . |
boolean |
isEmpty()
|
Set |
keySet()
|
Object |
put(Object key,
Object value)
Associates the specified value with the specified key in this map, after removing all old values associated with the key. |
void |
putAll(Map t)
Copies the mappings from the specified map to this map, after removing all old values associated with the key. |
Object |
remove(Object key)
Removes mappings from key to all associated values from this map. |
boolean |
remove(Object key,
Object value)
Removes a mapping from key to value from this map if present. |
boolean |
removeAll(Object key,
Collection values)
Removes from the current mappings: associations for key to any value in values . |
boolean |
retainAll(Object key,
Collection values)
Removes from the current mappings: associations for key to any value not in values . |
int |
size()
Returns the number of key-value mappings in this map (keys which map to multiple values count multiple times). |
String |
toString()
|
Collection |
values()
|
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public GenericInvertibleMultiMap(MultiMap.Factory mmf)
public GenericInvertibleMultiMap(MapFactory mf, CollectionFactory cf)
public GenericInvertibleMultiMap(CollectionFactory cf)
public GenericInvertibleMultiMap()
public GenericInvertibleMultiMap(Map m)
public GenericInvertibleMultiMap(MultiMap mm)
Method Detail |
public InvertibleMultiMap invert()
this
.
invert
in interface InvertibleMultiMap
public boolean add(Object key, Object value)
MultiMap
this
contains an association from
key
to value
.
(MultiMap
specific operation).
add
in interface MultiMap
true
if this mapping changed as a result of
the callpublic boolean addAll(Object key, Collection values)
MultiMap
key
to each value in values
.
(MultiMap
specific operation).
addAll
in interface MultiMap
true
if this mapping changed as a result
of the callpublic boolean addAll(MultiMap mm)
MultiMap
addAll
in interface MultiMap
public void clear()
clear
in interface Map
public boolean contains(Object a, Object b)
MultiMap
a
has a mapping to b
in this
.
(MultiMap
specific operation).
contains
in interface MultiMap
public boolean containsKey(Object key)
containsKey
in interface Map
public boolean containsValue(Object value)
containsValue
in interface Map
public Set entrySet()
Set
returned by this method is actually an
instance of MultiMapSet
.
entrySet
in interface Map
public boolean equals(Object o)
equals
in interface Map
equals
in class Object
public Object get(Object key)
MultiMap
null
if the map contains no mapping for the key;
it's also possible that the map explicitly maps the key to
null
. The containsKey
operation may
be used to distinquish these two cases.
Note that if only the put
method is used to
modify this
, then get
will operate
just as it would in any other Map
.
get
in interface MultiMap
public Collection getValues(Object key)
MultiMap
key
. Modifications to the returned
Collection
affect this
as well. If
there are no Values currently associated with
key
, constructs a new, potentially mutable, empty
Collection
and returns it.
(MultiMap
specific operation).
getValues
in interface MultiMap
public int hashCode()
hashCode
in interface Map
hashCode
in class Object
public boolean isEmpty()
isEmpty
in interface Map
public Set keySet()
keySet
in interface Map
public Object put(Object key, Object value)
MultiMap
null
if no values were
associated previously.
put
in interface MultiMap
public void putAll(Map t)
MultiMap
putAll(mm)
where mm
is a
MultiMap
will NOT add all of the mappings in
mm
; it will only add all of the Keys in
mm
, mapping each Key to one of the Values it
mapped to in mm
. To add all of the mappings from
another MultiMap
, use
addAll(MultiMap)
.
putAll
in interface MultiMap
public Object remove(Object key)
MultiMap
Map
definition of
remove
.
remove
in interface MultiMap
null
if Map
associated
no values with the key. Note that a zero-sized collection
is not returned in the latter case, and that a
null
return value may be ambiguous if the map
associated null
with the given key (in addition
to possibly other values).public boolean remove(Object key, Object value)
MultiMap
MultiMap
specific operation).
Note that if multiple mappings from key to value are permitted
by this map, then only one is guaranteed to be removed.
Returns true if this
was modified as a result of
this operation, else returns false.
remove
in interface MultiMap
public boolean removeAll(Object key, Collection values)
MultiMap
key
to any value in values
.
(MultiMap
specific operation).
removeAll
in interface MultiMap
true
if this mapping changed as a result
of the callpublic boolean retainAll(Object key, Collection values)
MultiMap
key
to any value not in values
.
(MultiMap
specific operation).
retainAll
in interface MultiMap
true
if this mapping changed as a result
of the callpublic int size()
MultiMap
size
in interface MultiMap
public String toString()
toString
in class Object
public Collection values()
values
in interface Map
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |