org.eclipse.collections.api.multimap.set.MutableSetIterableMultimap 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.multimap.MutableMultimap;
import org.eclipse.collections.api.multimap.bag.MutableBagIterableMultimap;
import org.eclipse.collections.api.set.MutableSetIterable;
import org.eclipse.collections.api.tuple.Pair;

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

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

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

    @Override
    MutableSetIterable removeAll(Object key);

    @Override
    MutableSetIterableMultimap newEmpty();

    @Override
    MutableSetIterable get(K key);

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

    @Override
    MutableSetIterableMultimap flip();

    @Override
    MutableSetIterableMultimap selectKeysValues(Predicate2 predicate);

    @Override
    MutableSetIterableMultimap rejectKeysValues(Predicate2 predicate);

    @Override
    MutableSetIterableMultimap selectKeysMultiValues(Predicate2> predicate);

    @Override
    MutableSetIterableMultimap rejectKeysMultiValues(Predicate2> predicate);

    @Override
     MutableBagIterableMultimap collectKeysValues(Function2> function);

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

    @Override
     MutableMultimap collectValues(Function function);

    @Override
    MutableSetIterableMultimap asSynchronized();
}