org.eclipse.collections.api.multimap.set.MutableSetMultimap 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) 2022 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.set;

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.block.procedure.Procedure2;
import org.eclipse.collections.api.multimap.bag.MutableBagMultimap;
import org.eclipse.collections.api.set.MutableSet;
import org.eclipse.collections.api.tuple.Pair;

/**
 * @since 1.0
 */
public interface MutableSetMultimap
        extends UnsortedSetMultimap, MutableSetIterableMultimap
{
    /**
     * Puts the key / value combination into the MutableSetMultimap and returns the MutableSetMultimap (this).
     * @since 11.1
     */
    @Override
    default MutableSetMultimap withKeyValue(K key, V value)
    {
        this.put(key, value);
        return this;
    }

    @Override
    default MutableSetMultimap withKeyMultiValues(K key, V... values)
    {
        return (MutableSetMultimap) MutableSetIterableMultimap.super.withKeyMultiValues(key, values);
    }

    /**
     * @since 11.0
     */
    void forEachKeyMutableSet(Procedure2> procedure);

    @Override
    MutableSet replaceValues(K key, Iterable values);

    @Override
    MutableSet removeAll(Object key);

    @Override
    MutableSetMultimap newEmpty();

    @Override
    MutableSet get(K key);

    @Override
    MutableSet getIfAbsentPutAll(K key, Iterable values);

    @Override
    MutableSetMultimap flip();

    @Override
    MutableSetMultimap selectKeysValues(Predicate2 predicate);

    @Override
    MutableSetMultimap rejectKeysValues(Predicate2 predicate);

    @Override
    MutableSetMultimap selectKeysMultiValues(Predicate2> predicate);

    @Override
    MutableSetMultimap rejectKeysMultiValues(Predicate2> predicate);

    @Override
     MutableBagMultimap collectKeysValues(Function2> function);

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

    @Override
     MutableBagMultimap collectValues(Function function);

    @Override
    MutableSetMultimap asSynchronized();
}