org.eclipse.collections.api.multimap.set.ImmutableSetMultimap 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) 2021 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.ImmutableBagMultimap;
import org.eclipse.collections.api.set.ImmutableSet;
import org.eclipse.collections.api.tuple.Pair;

/**
 * @since 1.0
 */
public interface ImmutableSetMultimap
        extends UnsortedSetMultimap, ImmutableSetIterableMultimap
{
    /**
     * @since 11.0
     */
    void forEachKeyImmutableSet(Procedure2> procedure);

    @Override
    ImmutableSet get(K key);

    @Override
    ImmutableSetMultimap newEmpty();

    @Override
    ImmutableSetMultimap newWith(K key, V value);

    @Override
    ImmutableSetMultimap newWithout(Object key, Object value);

    @Override
    ImmutableSetMultimap newWithAll(K key, Iterable values);

    @Override
    ImmutableSetMultimap newWithoutAll(Object key);

    @Override
    ImmutableSetMultimap flip();

    @Override
    ImmutableSetMultimap selectKeysValues(Predicate2 predicate);

    @Override
    ImmutableSetMultimap rejectKeysValues(Predicate2 predicate);

    @Override
    ImmutableSetMultimap selectKeysMultiValues(Predicate2> predicate);

    @Override
    ImmutableSetMultimap rejectKeysMultiValues(Predicate2> predicate);

    @Override
     ImmutableBagMultimap collectKeysValues(Function2> function);

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

    @Override
     ImmutableBagMultimap collectValues(Function function);
}