|
JUtil | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractMap<K,V>
net.cscott.jutil.AbstractMultiMap<K,V>
public abstract class AbstractMultiMap<K,V>
This class provides a skeletal implementation of the MultiMap
interface, to minimize the effort requires to implement this interface.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class java.util.AbstractMap |
---|
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V> |
Nested classes/interfaces inherited from interface java.util.Map |
---|
Map.Entry<K,V> |
Constructor Summary | |
---|---|
AbstractMultiMap()
|
Method Summary | |
---|---|
boolean |
add(K key,
V value)
Ensures that this contains an association from
key to value . |
boolean |
addAll(K key,
Collection<? extends V> values)
Adds to the current mappings: associations for key to each value in values . |
boolean |
addAll(MultiMap<? extends K,? extends V> mm)
Add all mappings in the given multimap to this multimap. |
abstract void |
clear()
|
abstract 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)
|
abstract MultiMapSet<K,V> |
entrySet()
Returns a Set view that allows you to recapture
the MultiMap view. |
boolean |
equals(Object o)
|
V |
get(Object key)
Returns some arbitrary value from the collection of values to which this map maps the specified key. |
abstract Collection<V> |
getValues(K key)
Returns the collection of Values associated with key . |
int |
hashCode()
|
boolean |
isEmpty()
|
V |
put(K key,
V value)
Associates the specified value with the specified key in this map. |
void |
putAll(Map<? extends K,? extends V> t)
Copies the mappings from the specified map to this map. |
abstract V |
remove(Object key)
Removes mappings from key to all associated values from this map. |
abstract boolean |
remove(Object key,
Object value)
Removes a mapping from key to value from this map if present. |
boolean |
removeAll(K key,
Collection<?> values)
Removes from the current mappings: associations for key to any value in values . |
boolean |
retainAll(K 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()
|
Methods inherited from class java.util.AbstractMap |
---|
clone, keySet, values |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Map |
---|
keySet, values |
Constructor Detail |
---|
public AbstractMultiMap()
Method Detail |
---|
public String toString()
toString
in class AbstractMap<K,V>
public int hashCode()
hashCode
in interface Map<K,V>
hashCode
in class AbstractMap<K,V>
public boolean add(K key, V value)
this
contains an association from
key
to value
.
(MultiMap
specific operation).
add
in interface MultiMap<K,V>
true
if this mapping changed as a result of
the callpublic boolean addAll(K key, Collection<? extends V> values)
key
to each value in values
.
(MultiMap
specific operation).
addAll
in interface MultiMap<K,V>
true
if this mapping changed as a result
of the callpublic boolean addAll(MultiMap<? extends K,? extends V> mm)
addAll
in interface MultiMap<K,V>
public boolean retainAll(K key, Collection<?> values)
key
to any value not in values
.
(MultiMap
specific operation).
retainAll
in interface MultiMap<K,V>
true
if this mapping changed as a result
of the callpublic boolean removeAll(K key, Collection<?> values)
key
to any value in values
.
(MultiMap
specific operation).
removeAll
in interface MultiMap<K,V>
true
if this mapping changed as a result
of the callpublic boolean equals(Object o)
equals
in interface Map<K,V>
equals
in class AbstractMap<K,V>
public void putAll(Map<? extends K,? extends V> t)
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 Map<K,V>
putAll
in interface MultiMap<K,V>
putAll
in class AbstractMap<K,V>
public V put(K key, V value)
null
if no values were associated previously.
put
in interface Map<K,V>
put
in interface MultiMap<K,V>
put
in class AbstractMap<K,V>
public boolean containsKey(Object key)
containsKey
in interface Map<K,V>
containsKey
in class AbstractMap<K,V>
public boolean containsValue(Object value)
containsValue
in interface Map<K,V>
containsValue
in class AbstractMap<K,V>
public boolean isEmpty()
isEmpty
in interface Map<K,V>
isEmpty
in class AbstractMap<K,V>
public int size()
MultiMap
size
in interface Map<K,V>
size
in interface MultiMap<K,V>
size
in class AbstractMap<K,V>
public V 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 Map<K,V>
get
in interface MultiMap<K,V>
get
in class AbstractMap<K,V>
public abstract Collection<V> getValues(K 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<K,V>
public abstract boolean contains(Object a, Object b)
MultiMap
a
has a mapping to b
in this
.
(MultiMap
specific operation).
contains
in interface MultiMap<K,V>
public abstract V remove(Object key)
MultiMap
Map
definition of
remove
.
remove
in interface Map<K,V>
remove
in interface MultiMap<K,V>
remove
in class AbstractMap<K,V>
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 abstract 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<K,V>
public abstract void clear()
clear
in interface Map<K,V>
clear
in class AbstractMap<K,V>
public abstract MultiMapSet<K,V> entrySet()
MultiMap
Set
view that allows you to recapture
the MultiMap
view.
entrySet
in interface Map<K,V>
entrySet
in interface MultiMap<K,V>
entrySet
in class AbstractMap<K,V>
|
JUtil | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |