org.eclipse.collections.api.multimap.ImmutableMultimap 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.
 * 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.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.ImmutableCollection;
import org.eclipse.collections.api.tuple.Pair;

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

    @Override
    ImmutableCollection get(K key);

    default ImmutableMultimap newWith(K key, V value)
    {
        MutableMultimap mutableMultimap = this.toMutable();
        mutableMultimap.put(key, value);
        return mutableMultimap.toImmutable();
    }

    default ImmutableMultimap newWithout(Object key, Object value)
    {
        MutableMultimap mutableMultimap = this.toMutable();
        mutableMultimap.remove(key, value);
        return mutableMultimap.toImmutable();
    }

    default ImmutableMultimap newWithAll(K key, Iterable values)
    {
        MutableMultimap mutableMultimap = this.toMutable();
        mutableMultimap.putAll(key, values);
        return mutableMultimap.toImmutable();
    }

    default ImmutableMultimap newWithoutAll(Object key)
    {
        MutableMultimap mutableMultimap = this.toMutable();
        mutableMultimap.removeAll(key);
        return mutableMultimap.toImmutable();
    }

    @Override
    ImmutableMultimap flip();

    @Override
    ImmutableMultimap selectKeysValues(Predicate2 predicate);

    @Override
    ImmutableMultimap rejectKeysValues(Predicate2 predicate);

    @Override
    ImmutableMultimap selectKeysMultiValues(Predicate2> predicate);

    @Override
    ImmutableMultimap rejectKeysMultiValues(Predicate2> predicate);

    @Override
     ImmutableMultimap collectKeysValues(Function2> function);

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

    @Override
     ImmutableMultimap collectValues(Function function);
}