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

import org.eclipse.collections.api.DoubleIterable;
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.DoubleToObjectFunction;
import org.eclipse.collections.api.block.predicate.primitive.DoubleObjectPredicate;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.tuple.primitive.DoubleObjectPair;

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

    /**
     * This method allows MutableDoubleObjectMap the ability to add an element in the form of {@code DoubleObjectPair}.
     *
     * @see #put(double, Object)
     * @since 9.1.0
     */
    default V putPair(DoubleObjectPair keyValuePair)
    {
        return this.put(keyValuePair.getOne(), keyValuePair.getTwo());
    }

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

    V removeKey(double key);

    V remove(double key);

    V getIfAbsentPut(double key, V value);

    V getIfAbsentPut(double key, Function0 function);

    V getIfAbsentPutWithKey(double key, DoubleToObjectFunction function);

     V getIfAbsentPutWith(double 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(double key, Function0 factory, Function function);

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

    @Override
    MutableObjectDoubleMap flipUniqueValues();

    @Override
    MutableDoubleObjectMap tap(Procedure procedure);

    @Override
    MutableDoubleObjectMap select(DoubleObjectPredicate predicate);

    @Override
    MutableDoubleObjectMap reject(DoubleObjectPredicate predicate);

    MutableDoubleObjectMap withKeyValue(double key, V value);

    MutableDoubleObjectMap withoutKey(double key);

    MutableDoubleObjectMap withoutAllKeys(DoubleIterable keys);

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

    MutableDoubleObjectMap asUnmodifiable();

    MutableDoubleObjectMap asSynchronized();
}