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

import org.eclipse.collections.api.block.function.primitive.IntFunction;
import org.eclipse.collections.api.block.function.primitive.IntFunction0;
import org.eclipse.collections.api.block.function.primitive.IntToIntFunction;
import org.eclipse.collections.api.block.function.primitive.IntToObjectFunction;
import org.eclipse.collections.api.block.function.primitive.ObjectIntToIntFunction;
import org.eclipse.collections.api.block.predicate.primitive.IntPredicate;
import org.eclipse.collections.api.block.procedure.primitive.IntProcedure;
import org.eclipse.collections.api.block.predicate.primitive.ObjectIntPredicate;
import org.eclipse.collections.api.collection.MutableCollection;
import org.eclipse.collections.api.collection.primitive.MutableIntCollection;
import org.eclipse.collections.api.iterator.MutableIntIterator;
import org.eclipse.collections.api.tuple.primitive.ObjectIntPair;

/**
 * This file was automatically generated from template file mutableObjectPrimitiveMap.stg.
 *
 * @since 3.0.
 */
public interface MutableObjectIntMap extends ObjectIntMap
{
    @Override
    MutableIntIterator intIterator();

    void clear();

    void put(K key, int value);

    /**
     * This method allows MutableObjectIntMap the ability to add an element in the form of {@code ObjectIntPair}.
     *
     * @see #put(Object, int)
     * @since 9.1.0
     */
    default void putPair(ObjectIntPair keyValuePair)
    {
        this.put(keyValuePair.getOne(), keyValuePair.getTwo());
    }

    void putAll(ObjectIntMap map);

    /**
     * Updates the values in-place.
     *
     * @param function that takes a key and its value and that returns a new value for this key
     * @since 10.0
     */
    void updateValues(ObjectIntToIntFunction function);

    void removeKey(K key);

    void remove(Object key);

    int removeKeyIfAbsent(K key, int value);

    int getIfAbsentPut(K key, int value);

    int getIfAbsentPut(K key, IntFunction0 function);

    int getIfAbsentPutWithKey(K key, IntFunction function);

     int getIfAbsentPutWith(K key, IntFunction function, P parameter);

    int updateValue(K key, int initialValueIfAbsent, IntToIntFunction function);

    @Override
    MutableIntObjectMap flipUniqueValues();

    @Override
    MutableObjectIntMap select(ObjectIntPredicate predicate);

    @Override
    MutableObjectIntMap reject(ObjectIntPredicate predicate);

    @Override
    MutableIntCollection select(IntPredicate predicate);

    @Override
    MutableIntCollection reject(IntPredicate predicate);

    /**
     * @since 9.0.
     */
    default MutableObjectIntMap tap(IntProcedure procedure)
    {
        this.forEach(procedure);
        return this;
    }

    @Override
     MutableCollection collect(IntToObjectFunction function);

    MutableObjectIntMap withKeyValue(K key, int value);

    MutableObjectIntMap withoutKey(K key);

    MutableObjectIntMap withoutAllKeys(Iterable keys);

    default MutableObjectIntMap withAllKeyValues(Iterable> keyValuePairs)
    {
        for (ObjectIntPair keyValuePair : keyValuePairs)
        {
            this.putPair(keyValuePair);
        }
        return this;
    }

    MutableObjectIntMap asUnmodifiable();

    MutableObjectIntMap asSynchronized();

    int addToValue(K key, int toBeAdded);
}