org.mattressframework.api.MultiValuedMap Maven / Gradle / Ivy
/*
* Copyright 2007-2008, Josh Devins.
*
* 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.mattressframework.api;
import java.util.List;
import java.util.Map;
/**
* A map of key-values pairs. Each key can have zero or more values.
*
* @author Josh Devins ([email protected])
*/
public interface MultiValuedMap extends Map> {
/**
* Add a value to the current list of values for the supplied key.
*/
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);
/**
* Set the key's value to be a one item list consisting of the supplied
* value. Any existing values will be replaced.
*/
void putSingle(K key, V value);
}