org.eclipse.collections.api.map.MutableMap 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 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.map;

import java.util.Map;

import org.eclipse.collections.api.bag.MutableBag;
import org.eclipse.collections.api.bag.primitive.MutableBooleanBag;
import org.eclipse.collections.api.bag.primitive.MutableByteBag;
import org.eclipse.collections.api.bag.primitive.MutableCharBag;
import org.eclipse.collections.api.bag.primitive.MutableDoubleBag;
import org.eclipse.collections.api.bag.primitive.MutableFloatBag;
import org.eclipse.collections.api.bag.primitive.MutableIntBag;
import org.eclipse.collections.api.bag.primitive.MutableLongBag;
import org.eclipse.collections.api.bag.primitive.MutableShortBag;
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.factory.Maps;
import org.eclipse.collections.api.multimap.bag.MutableBagMultimap;
import org.eclipse.collections.api.multimap.set.MutableSetMultimap;
import org.eclipse.collections.api.ordered.OrderedIterable;
import org.eclipse.collections.api.partition.bag.PartitionMutableBag;
import org.eclipse.collections.api.set.MutableSet;
import org.eclipse.collections.api.tuple.Pair;

/**
 * A MutableMap is similar to a JCF Map but adds additional useful internal iterator methods. The MutableMap interface
 * additionally implements some of the methods in the Smalltalk Dictionary protocol.
 */
public interface MutableMap
        extends MutableMapIterable, UnsortedMapIterable, Cloneable
{
    /**
     * Adds all the entries derived from {@code iterable} to {@code this}. The key and value for each entry
     * is determined by applying the {@code keyFunction} and {@code valueFunction} to each item in
     * {@code collection}. Any entry in {@code map} that has the same key as an entry in {@code this}
     * will have its value replaced by that in {@code map}.
     */
     MutableMap collectKeysAndValues(
            Iterable iterable,
            Function keyFunction,
            Function valueFunction);

    @Override
    MutableMap newEmpty();

    MutableMap clone();

    @Override
    MutableMap asUnmodifiable();

    @Override
    MutableMap asSynchronized();

    @Override
    MutableSetMultimap flip();

    @Override
    MutableMap select(Predicate2 predicate);

    @Override
    MutableMap reject(Predicate2 predicate);

    @Override
     MutableMap collectValues(Function2 function);

    @Override
     MutableMap collect(Function2> function);

    @Override
    MutableMap tap(Procedure procedure);

    @Override
    MutableBag select(Predicate predicate);

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

    @Override
    MutableBag reject(Predicate predicate);

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

    @Override
    PartitionMutableBag partition(Predicate predicate);

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

    @Override
     MutableBag selectInstancesOf(Class clazz);

    @Override
     MutableBag collect(Function function);

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

    @Override
    MutableBooleanBag collectBoolean(BooleanFunction booleanFunction);

    @Override
    MutableByteBag collectByte(ByteFunction byteFunction);

    @Override
    MutableCharBag collectChar(CharFunction charFunction);

    @Override
    MutableDoubleBag collectDouble(DoubleFunction doubleFunction);

    @Override
    MutableFloatBag collectFloat(FloatFunction floatFunction);

    @Override
    MutableIntBag collectInt(IntFunction intFunction);

    @Override
    MutableLongBag collectLong(LongFunction longFunction);

    @Override
    MutableShortBag collectShort(ShortFunction shortFunction);

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

    @Override
     MutableBag flatCollect(Function> function);

    /**
     * @since 9.2
     */
    @Override
    default  MutableBag 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
     MutableBag> zip(Iterable that);

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

    @Override
     MutableBagMultimap groupBy(Function function);

    @Override
     MutableBagMultimap groupByEach(Function> function);

    @Override
    default  MutableMap groupByUniqueKey(Function function)
    {
        return this.groupByUniqueKey(function, Maps.mutable.withInitialCapacity(this.size()));
    }

    @Override
    default  MutableMap aggregateInPlaceBy(
            Function groupBy,
            Function0 zeroValueFactory,
            Procedure2 mutatingAggregator)
    {
        MutableMap map = Maps.mutable.empty();
        this.forEach(each ->
        {
            KK key = groupBy.valueOf(each);
            VV value = map.getIfAbsentPut(key, zeroValueFactory);
            mutatingAggregator.value(value, each);
        });
        return map;
    }

    @Override
    default  MutableMap aggregateBy(
            Function groupBy,
            Function0 zeroValueFactory,
            Function2 nonMutatingAggregator)
    {
        return this.aggregateBy(
                groupBy,
                zeroValueFactory,
                nonMutatingAggregator,
                Maps.mutable.empty());
    }

    @Override
    default  MutableMap aggregateBy(
            Function keyFunction,
            Function valueFunction,
            Function0 zeroValueFactory,
            Function2 nonMutatingAggregator)
    {
        MutableMap map = Maps.mutable.empty();
        this.forEachKeyValue((key, value) -> {
            map.updateValueWith(keyFunction.valueOf(key), zeroValueFactory, nonMutatingAggregator, valueFunction.valueOf(value));
        });
        return map;
    }

    @Override
    MutableMap flipUniqueValues();

    @Override
    MutableMap withKeyValue(K key, V value);

    @Override
    default MutableMap withMap(Map map)
    {
        this.putAll(map);
        return this;
    }

    @Override
    MutableMap withAllKeyValues(Iterable> keyValues);

    @Override
    MutableMap withAllKeyValueArguments(Pair... keyValuePairs);

    @Override
    MutableMap withoutKey(K key);

    @Override
    MutableMap withoutAllKeys(Iterable keys);
}