javax.ws.rs.core.MultivaluedMap Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.ws.rs.core;
import java.util.List;
import java.util.Map;
/**
* A map of key-values pairs. Each key can have zero or more values.
*
* @param the type of keys maintained by this map
* @param the type of mapped values
* @author Paul Sandoz
* @author Marc Hadley
* @author Marek Potociar
* @since 1.0
*/
public interface MultivaluedMap extends Map> {
/**
* Set the key's value to be a one item list consisting of the supplied value.
* Any existing values will be replaced.
*
* @param key the key
* @param value the single value of the key
*/
void putSingle(K key, V value);
/**
* Add a value to the current list of values for the supplied key.
*
* @param key the key
* @param value the value to be added.
*/
void add(K key, V value);
/**
* A shortcut to get the first value of the supplied key.
*
* @param key the key
* @return the first value for the specified key or null if the key is
* not in the map.
*/
V getFirst(K key);
/**
* Add multiple values to the current list of values for the supplied key. If
* the supplied array of new values is empty, method returns immediately.
* Method throws a {@code NullPointerException} if the supplied array of values
* is {@code null}.
*
* @param key the key.
* @param newValues the values to be added.
* @throws NullPointerException if the supplied array of new values is {@code null}.
* @since 2.0
*/
void addAll(K key, V... newValues);
/**
* Add all the values from the supplied value list to the current list of
* values for the supplied key. If the supplied value list is empty, method
* returns immediately. Method throws a {@code NullPointerException} if the
* supplied array of values is {@code null}.
*
* @param key the key.
* @param valueList the list of values to be added.
* @throws NullPointerException if the supplied value list is {@code null}.
* @since 2.0
*/
void addAll(K key, List valueList);
/**
* Add a value to the first position in the current list of values for the
* supplied key.
*
* @param key the key
* @param value the value to be added.
* @since 2.0
*/
void addFirst(K key, V value);
/**
* Compare the specified map with this map for equality modulo the order
* of values for each key. Specifically, the values associated with
* each key are compared as if they were ordered lists.
*
* @param otherMap map to be compared to this one.
* @return true if the maps are equal modulo value ordering.
* @since 2.0
*/
boolean equalsIgnoreValueOrder(MultivaluedMap otherMap);
}