org.eclipse.collections.api.map.ImmutableMap 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) 2018 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.map;

import org.eclipse.collections.api.bag.ImmutableBag;
import org.eclipse.collections.api.bag.primitive.ImmutableBooleanBag;
import org.eclipse.collections.api.bag.primitive.ImmutableByteBag;
import org.eclipse.collections.api.bag.primitive.ImmutableCharBag;
import org.eclipse.collections.api.bag.primitive.ImmutableDoubleBag;
import org.eclipse.collections.api.bag.primitive.ImmutableFloatBag;
import org.eclipse.collections.api.bag.primitive.ImmutableIntBag;
import org.eclipse.collections.api.bag.primitive.ImmutableLongBag;
import org.eclipse.collections.api.bag.primitive.ImmutableShortBag;
import org.eclipse.collections.api.block.function.Function;
import org.eclipse.collections.api.block.function.Function0;
import org.eclipse.collections.api.block.function.Function2;
import org.eclipse.collections.api.block.function.primitive.BooleanFunction;
import org.eclipse.collections.api.block.function.primitive.ByteFunction;
import org.eclipse.collections.api.block.function.primitive.CharFunction;
import org.eclipse.collections.api.block.function.primitive.DoubleFunction;
import org.eclipse.collections.api.block.function.primitive.FloatFunction;
import org.eclipse.collections.api.block.function.primitive.IntFunction;
import org.eclipse.collections.api.block.function.primitive.LongFunction;
import org.eclipse.collections.api.block.function.primitive.ShortFunction;
import org.eclipse.collections.api.block.predicate.Predicate;
import org.eclipse.collections.api.block.predicate.Predicate2;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.block.procedure.Procedure2;
import org.eclipse.collections.api.multimap.bag.ImmutableBagMultimap;
import org.eclipse.collections.api.multimap.set.ImmutableSetMultimap;
import org.eclipse.collections.api.ordered.OrderedIterable;
import org.eclipse.collections.api.partition.bag.PartitionImmutableBag;
import org.eclipse.collections.api.set.ImmutableSet;
import org.eclipse.collections.api.tuple.Pair;

/**
 * An ImmutableMap is different than a JCF Map but in that it has no mutating methods. It shares the read-only
 * protocol of a JDK Map.
 */
public interface ImmutableMap
        extends UnsortedMapIterable, ImmutableMapIterable
{
    @Override
    ImmutableMap newWithKeyValue(K key, V value);

    @Override
    ImmutableMap newWithAllKeyValues(Iterable> keyValues);

    @Override
    ImmutableMap newWithAllKeyValueArguments(Pair... keyValuePairs);

    @Override
    ImmutableMap newWithoutKey(K key);

    @Override
    ImmutableMap newWithoutAllKeys(Iterable keys);

    MutableMap toMap();

    @Override
    ImmutableSetMultimap flip();

    @Override
    ImmutableMap select(Predicate2 predicate);

    @Override
    ImmutableMap reject(Predicate2 predicate);

    @Override
    ImmutableMap tap(Procedure procedure);

    @Override
    ImmutableBag select(Predicate predicate);

    @Override
     ImmutableBag selectWith(Predicate2 predicate, P parameter);

    @Override
    ImmutableBag reject(Predicate predicate);

    @Override
    
 ImmutableBag rejectWith(Predicate2 predicate, P parameter);

    @Override
    PartitionImmutableBag partition(Predicate predicate);

    @Override
     PartitionImmutableBag partitionWith(Predicate2 predicate, P parameter);

    @Override
     ImmutableBag selectInstancesOf(Class clazz);

    @Override
     ImmutableMap collect(Function2> function);

    @Override
     ImmutableMap collectValues(Function2 function);

    @Override
     ImmutableBag collect(Function function);

    @Override
     ImmutableBag collectWith(Function2 function, P parameter);

    @Override
    ImmutableBooleanBag collectBoolean(BooleanFunction booleanFunction);

    @Override
    ImmutableByteBag collectByte(ByteFunction byteFunction);

    @Override
    ImmutableCharBag collectChar(CharFunction charFunction);

    @Override
    ImmutableDoubleBag collectDouble(DoubleFunction doubleFunction);

    @Override
    ImmutableFloatBag collectFloat(FloatFunction floatFunction);

    @Override
    ImmutableIntBag collectInt(IntFunction intFunction);

    @Override
    ImmutableLongBag collectLong(LongFunction longFunction);

    @Override
    ImmutableShortBag collectShort(ShortFunction shortFunction);

    @Override
     ImmutableBag collectIf(Predicate predicate, Function function);

    @Override
     ImmutableBag flatCollect(Function> function);

    /**
     * @since 9.2
     */
    @Override
    default  ImmutableBag flatCollectWith(Function2> function, P parameter)
    {
        return this.flatCollect(each -> function.apply(each, parameter));
    }

    /**
     * @deprecated in 6.0. Use {@link OrderedIterable#zip(Iterable)} instead.
     */
    @Override
    @Deprecated
     ImmutableBag> zip(Iterable that);

    /**
     * @deprecated in 6.0. Use {@link OrderedIterable#zipWithIndex()} instead.
     */
    @Override
    @Deprecated
    ImmutableSet> zipWithIndex();

    @Override
     ImmutableBagMultimap groupBy(Function function);

    @Override
     ImmutableBagMultimap groupByEach(Function> function);

    @Override
     ImmutableMap groupByUniqueKey(Function function);

    @Override
     ImmutableMap aggregateInPlaceBy(
            Function groupBy,
            Function0 zeroValueFactory,
            Procedure2 mutatingAggregator);

    @Override
     ImmutableMap aggregateBy(
            Function groupBy,
            Function0 zeroValueFactory,
            Function2 nonMutatingAggregator);

    @Override
    ImmutableMap flipUniqueValues();
}