Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

Util.Collections
Interface InvertibleMultiMap  view InvertibleMultiMap download InvertibleMultiMap.java

All Superinterfaces:
BinaryRelation, InvertibleMap, java.util.Map, MultiMap
All Known Implementing Classes:
GenericInvertibleMultiMap

public interface InvertibleMultiMap
extends MultiMap, InvertibleMap

An InvertibleMultiMap is an extension of the MultiMap interface to allow users to do reverse lookups on the mappings maintained. If, for MultiMap m, m.contains(a, b), then m.invert().contains(b, a). If the InvertibleMultiMap is mutable, the InvertibleMultiMap returned by its invert() method should also be mutable. Moreover, for any InvertibleMultiMap, this.invert().invert()==this.

Version:
$Id: InvertibleMultiMap.java,v 1.1 2003/03/29 07:58:35 joewhaley Exp $

Nested Class Summary
 
Nested classes inherited from class java.util.Map
java.util.Map.Entry
 
Method Summary
 MultiMap invert()
          Returns a inverted view of this.
 
Methods inherited from interface Util.Collections.MultiMap
add, addAll, addAll, computeHistogram, contains, entrySet, get, getValues, put, putAll, remove, remove, removeAll, retainAll, size
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, values
 

Method Detail

invert

public MultiMap invert()
Returns a inverted view of this. Thus, if this is a MultiMap with domain A and range B, the returned MultiMap, imap, will be a MultiMap with domain B and range A, such that b in B will map in imap to a collection containing a, if and only if a in this maps to a collection containing b.

Specified by:
invert in interface InvertibleMap