org.eclipse.collections.api.multimap.MutableMultimap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eclipse-collections-api Show documentation

There is a newer version: 12.0.0.M3

Show newest version

/*
 * Copyright (c) 2015 Goldman Sachs.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v. 1.0 which accompany this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 */

package org.eclipse.collections.api.multimap;

import org.eclipse.collections.api.RichIterable;
import org.eclipse.collections.api.block.function.Function;
import org.eclipse.collections.api.block.function.Function2;
import org.eclipse.collections.api.block.predicate.Predicate2;
import org.eclipse.collections.api.collection.MutableCollection;
import org.eclipse.collections.api.tuple.Pair;

/**
 * @since 1.0
 */
public interface MutableMultimap
        extends Multimap
{
    MutableMultimap newEmpty();

    MutableCollection get(K key);

    // Modification Operations

    boolean put(K key, V value);

    /**
     * Modification operation similar to put, however, takes the key-value pair as the input.
     *
     * @param keyValuePair
     *         key value pair to add in the multimap
     * @see #put(Object, Object)
     * @since 6.0
     */
    boolean add(Pair keyValuePair);

    boolean remove(Object key, Object value);

    // Bulk Operations
    boolean putAllPairs(Pair... pairs);

    boolean putAll(K key, Iterable values);

     boolean putAll(Multimap multimap);

    RichIterable replaceValues(K key, Iterable values);

    RichIterable removeAll(Object key);

    void clear();

    MutableMultimap flip();

    MutableMultimap selectKeysValues(Predicate2 predicate);

    MutableMultimap rejectKeysValues(Predicate2 predicate);

    MutableMultimap selectKeysMultiValues(Predicate2> predicate);

    MutableMultimap rejectKeysMultiValues(Predicate2> predicate);

     MutableMultimap collectKeysValues(Function2> function);

     MutableMultimap collectValues(Function function);
}