com.github.datalking.common.MultiValueMap Maven / Gradle / Ivy

Go to download
package com.github.datalking.common;

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

/**
 * map扩展 可存储多个value
 */
public interface MultiValueMap extends Map> {

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

    /**
     * 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);

    /**
     * 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();

}