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

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) 2019 Goldman Sachs and others.
 * 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.map.MutableMapIterable;
import org.eclipse.collections.api.tuple.Pair;

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

    @Override
    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
     */
    default boolean add(Pair keyValuePair)
    {
        return this.put(keyValuePair.getOne(), keyValuePair.getTwo());
    }

    boolean remove(Object key, Object value);

    // Bulk Operations
    default boolean putAllPairs(Pair... pairs)
    {
        boolean changed = false;
        for (Pair pair : pairs)
        {
            changed |= this.put(pair.getOne(), pair.getTwo());
        }
        return changed;
    }

    default boolean putAllPairs(Iterable> pairs)
    {
        boolean changed = false;
        for (Pair pair : pairs)
        {
            changed |= this.put(pair.getOne(), pair.getTwo());
        }
        return changed;
    }

    boolean putAll(K key, Iterable values);

     boolean putAll(Multimap multimap);

    RichIterable replaceValues(K key, Iterable values);

    RichIterable removeAll(Object key);

    /**
     * Puts values into multimap if there are no values already associated with key.
     * Then returns a view of the values associated with key, like the result of {@link Multimap#get(Object)}
     *
     * @since 10.0
     */
    MutableCollection getIfAbsentPutAll(K key, Iterable values);

    void clear();

    @Override
    MutableMultimap flip();

    @Override
    MutableMultimap selectKeysValues(Predicate2 predicate);

    @Override
    MutableMultimap rejectKeysValues(Predicate2 predicate);

    @Override
    MutableMultimap selectKeysMultiValues(Predicate2> predicate);

    @Override
    MutableMultimap rejectKeysMultiValues(Predicate2> predicate);

    @Override
     MutableMultimap collectKeysValues(Function2> function);

    @Override
     MutableMultimap collectValues(Function function);

    @Override
     MutableMultimap collectKeyMultiValues(Function keyFunction, Function valueFunction);

    /**
     * Returns a synchronized wrapper backed by this multimap.
     *
     * The preferred way of iterating over a synchronized multimap is to use the forEachKey(), forEachValue(),
     * forEachKeyValue() and forEachKeyMultiValues methods which are properly synchronized internally.
     *      *  MutableMultimap synchedMultimap = multimap.asSynchronized();
     *
     *  synchedMultimap.forEachKey(key -> ... );
     *  synchedMultimap.forEachValue(value -> ... );
     *  synchedMultimap.forEachKeyValue((key, value) -> ... );
     *  synchedMultimap.forEachKeyMultiValues((key, values) -> ... );
     * 
     * 
     * If you want to iterate imperatively over the keySet(), keysView(), valuesView(), or other views, you will
     * need to protect the iteration by wrapping the code in a synchronized block on the multimap.
     * 
     *
     * @return a synchronized view of this multimap.
     * @see MutableMapIterable#asSynchronized()
     * @since 8.0
     */
    MutableMultimap asSynchronized();
}