org.batoo.common.util.MultiValueMap Maven / Gradle / Ivy

/*
 * Copyright 2002-2009 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.batoo.common.util;

import java.util.List;
import java.util.Map;

/**
 * Extension of the {@code Map} interface that stores multiple values.
 * 
 * The original code is based on org.springframework.util.MultiValueMap
 * 
 * @param 
 *            The type of the key
 * @param 
 *            The value of the key
 * @author hceylan
 * @since 2.0.1
 */
public interface MultiValueMap extends Map> {

	/**
	 * Add the given single value to the current list of values for the given key.
	 * 
	 * @param key
	 *            the key
	 * @param value
	 *            the value to be added
	 */
	void add(K key, V value);

	/**
	 * Return the first value for the given key.
	 * 
	 * @param key
	 *            the key
	 * @return the first value for the specified key, or null
	 */
	V getFirst(K key);

	/**
	 * Set the given single value under the given key.
	 * 
	 * @param key
	 *            the key
	 * @param value
	 *            the value to set
	 */
	void set(K key, V value);

	/**
	 * Set the given values under.
	 * 
	 * @param values
	 *            the values.
	 */
	void setAll(Map values);

	/**
	 * Returns the first values contained in this {@code MultiValueMap}.
	 * 
	 * @return a single value representation of this map
	 */
	Map toSingleValueMap();

}