/*
 * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/MultiMap.java,v 1.4 2002/06/12 03:59:15 mas Exp $
 * $Revision: 1.4 $
 * $Date: 2002/06/12 03:59:15 $
 *
 * ====================================================================
 *
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */
package org.apache.commons.collections;

import java.util.Map;

/** 
 * This is simply a Map with slightly different semantics.
 * Instead of returning an Object, it returns a Collection.
 * So for example, you can put( key, new Integer(1) ); 
 * and then a Object get( key ); will return you a Collection 
 * instead of an Integer.
 * Thus, this is simply a tag interface.
 *
 * @since 2.0
 * @author Christopher Berry
 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
 */
public interface MultiMap extends Map {
    
    public Object remove( Object key, Object item );
   
}

@@ -158,33 +158,41 @@
 v 1.
-4
+5
  2002/
-06/12 03:59:15 mas
+11/24 19:33:19 scolebourne
  Exp
@@ -210,17 +210,17 @@
 sion: 1.
-4
+5
  $%0A * $D
@@ -233,22 +233,22 @@
 002/
-06/12 03:59:15
+11/24 19:33:19
  $%0A 
@@ -3038,54 +3038,308 @@
 %0A * 
-Instead of returning an Object, it returns a C
+%3Cp%3E%0A * A %3Ccode%3EMultiMap%3C/code%3E is a Map with slightly different semantics.%0A * Putting a value into the map will add the value to a Collection at that%0A * key. Getting a value will always return a Collection, holding all the%0A * values put to that key. This implementation uses an ArrayList as the %0A * c
 olle
@@ -3352,12 +3352,16 @@
 %0A * 
-So f
+%3Cp%3E%0A * F
 or e
@@ -3370,175 +3370,244 @@
 mple
-, you can put( key, new Integer(1) 
+:%0A * %3Cpre%3E%0A * MultiMap mhm = new MultiHashMap();%0A * mhm.put(key, %22A%22
 );
- 
 %0A * 
-and then a Object ge
+mhm.put(key, %22B%22);%0A * mhm.pu
 t(
- 
 key
- ); will return you a Collection %0A * instead of an Integer.%0A * Thus, this is simply a tag interface
+, %22C%22);%0A * Collection coll = (Collection) mhm.get(key);%3C/pre%3E%0A * %3Cp%3E%0A * %3Ccode%3Ecoll%3C/code%3E will be a list containing %22A%22, %22B%22, %22C%22
 .%0A *
@@ -3718,16 +3718,46 @@
 han%3C/a%3E%0A
+ * @author Stephen Colebourne%0A
  */%0Apubl
@@ -3797,16 +3797,307 @@
  %7B%0A    %0A
+    /**%0A     * Removes a specific value from map.%0A     * %3Cp%3E%0A     * The item is removed from the collection mapped to the specified key.%0A     * %0A     * @param key  the key to remove from%0A     * @param value  the value to remove%0A     * @return the value removed (which was passed in)%0A     */%0A
     publ
@@ -4113,17 +4113,16 @@
  remove(
- 
 Object k
@@ -4136,17 +4136,16 @@
 ect item
- 
 );%0A   %0A%7D

Improve javadoc description of what a MultiMap is