org.biomage.tools.xmlutils
Interface MultiMap

All Superinterfaces:

java.util.Map

All Known Implementing Classes:

MultiHashMap, MultiHashtable

public interface MultiMap

extends java.util.Map

Utility interface for associating multiple values with a key.

Nested Class Summary

Nested classes inherited from class java.util.Map

java.util.Map.Entry

Method Summary

java.lang.Object	remove(java.lang.Object key, java.lang.Object value) Remove the given ( key, value ) pair from this MultiMap.
boolean	removeAll(java.lang.Object obj) Remove all references to an Object (all values and a key, if any).
java.util.Collection	valuesSets()

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

remove

public java.lang.Object remove(java.lang.Object key,
                               java.lang.Object value)

Remove the given ( key, value ) pair from this MultiMap. If that was the only entry for the given key, the key will be removed altogether.

Returns:

The given value, or null if the given ( key, value ) pair was not in the MultiMap.

removeAll

public boolean removeAll(java.lang.Object obj)

Remove all references to an Object (all values and a key, if any).

Returns:

true iff anything was removed.

valuesSets

public java.util.Collection valuesSets()

Returns:

The Collection of Sets, one for each present key. Any set returned may be null or empty. The Collection may also be null or empty.