com.gs.collections.api.multimap.ImmutableMultimap Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Goldman Sachs.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.gs.collections.api.multimap;

import com.gs.collections.api.block.function.Function;
import com.gs.collections.api.block.function.Function2;
import com.gs.collections.api.block.predicate.Predicate2;
import com.gs.collections.api.collection.ImmutableCollection;
import com.gs.collections.api.tuple.Pair;

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

    ImmutableCollection get(K key);

    ImmutableMultimap newWith(K key, V value);

    ImmutableMultimap newWithout(Object key, Object value);

    ImmutableMultimap newWithAll(K key, Iterable values);

    ImmutableMultimap newWithoutAll(Object key);

    ImmutableMultimap flip();

    ImmutableMultimap selectKeysValues(Predicate2 predicate);

    ImmutableMultimap rejectKeysValues(Predicate2 predicate);

    ImmutableMultimap selectKeysMultiValues(Predicate2> predicate);

    ImmutableMultimap rejectKeysMultiValues(Predicate2> predicate);

     ImmutableMultimap collectKeysValues(Function2> function);

     ImmutableMultimap collectValues(Function function);
}