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

import org.eclipse.collections.api.IntIterable;
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.IntToObjectFunction;
import org.eclipse.collections.api.block.predicate.primitive.IntObjectPredicate;
import org.eclipse.collections.api.block.procedure.Procedure;

/**
 * This file was automatically generated from template file mutablePrimitiveObjectMap.stg.
 *
 * @since 3.0.
 */
public interface MutableIntObjectMap extends IntObjectMap, MutablePrimitiveObjectMap
{
    V put(int key, V value);

    /**
     * @since 5.0.
     */
    void putAll(IntObjectMap map);

    V removeKey(int key);

    V remove(int key);

    V getIfAbsentPut(int key, V value);

    V getIfAbsentPut(int key, Function0 function);

    V getIfAbsentPutWithKey(int key, IntToObjectFunction function);

     V getIfAbsentPutWith(int key, Function function, P parameter);

    /**
     * Look up the value associated with {@code key}, apply the {@code function} to it, and replace the value. If there
     * is no value associated with {@code key}, start it off with a value supplied by {@code factory}.
     */
    V updateValue(int key, Function0 factory, Function function);

    /**
     * Same as {@link #updateValue(int, Function0, Function)} with a Function2 and specified parameter which is
     * passed to the function.
     */
     V updateValueWith(int key, Function0 factory, Function2 function, P parameter);

    MutableIntObjectMap tap(Procedure procedure);

    MutableIntObjectMap select(IntObjectPredicate predicate);

    MutableIntObjectMap reject(IntObjectPredicate predicate);

    MutableIntObjectMap withKeyValue(int key, V value);

    MutableIntObjectMap withoutKey(int key);

    MutableIntObjectMap withoutAllKeys(IntIterable keys);

    MutableIntObjectMap asUnmodifiable();

    MutableIntObjectMap asSynchronized();
}