Interface MultiMap

src/main/java/pascal/taie/util/collection/MultiMap.java:60–181

A collection that maps keys to values, similar to java.util.Map, but in which each key may be associated with multiple values. The values associated with the same key contain no duplicates. You can visualize the contents of a multimap either as a map from keys to nonempty</i

 * @param <V> type of the values in this map
 */
public interface MultiMap<K, V> {

    /**
     * @return {@code true} if this multimap contains at least one key-value pair
     * with the key {@code key} and the value {@code value}.
     */
    boolean contains(K key, V value);

    /**
     * @return {@code true} if this multimap contains at least one key-value pair
     * with the key {@code key}.
     */
    boolean containsKey(K key);

    /**
     * @return {@code true} if this multimap contains at least one key-value pair
     * with the value {@code value}. Note that this operation may be slow
     * compared to {@link #containsKey(Object)} in some implementations.
     */
    boolean containsValue(V value);

    /**
     * @return an unmodifiable view of the values associated with {@code key}
     * in this multimap, if {@code key} is absent; otherwise, this returns
     * an empty set.
     */
    Set<V> get(K key);

    /**
     * Stores a key-value pair in this multimap.
     *
     * @return {@code true} if the multimap changed.
     */
    boolean put(@Nonnull K key, @Nonnull V value);

    /**
     * Stores a key-value pair in this multimap for each of {@code values},
     * all using the same key, {@code key}.=
     */
    boolean putAll(@Nonnull K key, @Nonnull Collection<? extends V> values);

    /**
     * Stores all key-value pairs of {@code multimap} in this multimap.
     *
     * @return {@code true} if the multimap changed
     */
    boolean putAll(@Nonnull MultiMap<? extends K, ? extends V> multiMap);

    /**
     * Removes a single key-value pair with the key {@code key} and the value
     * {@code value} from this multimap, if such exists.
     *
     * @return {@code true} if the multimap changed
     */
    boolean remove(K key, V value);

    /**
     * Removes all values associated with the key {@code key}.