org.eclipse.collections.api.map.primitive.MutableByteDoubleMap 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.ByteIterable;
import org.eclipse.collections.api.block.function.primitive.ByteToDoubleFunction;
import org.eclipse.collections.api.block.function.primitive.DoubleFunction;
import org.eclipse.collections.api.block.function.primitive.DoubleFunction0;
import org.eclipse.collections.api.block.function.primitive.DoubleToDoubleFunction;
import org.eclipse.collections.api.block.function.primitive.ByteDoubleToDoubleFunction;
import org.eclipse.collections.api.block.predicate.primitive.ByteDoublePredicate;
import org.eclipse.collections.api.tuple.primitive.ByteDoublePair;

/**
 * This file was automatically generated from template file mutablePrimitivePrimitiveMap.stg.
 *
 * @since 3.0.
 */
public interface MutableByteDoubleMap extends ByteDoubleMap, MutableDoubleValuesMap
{
    void put(byte key, double value);

    /**
     * This method allows MutableByteDoubleMap the ability to add an element in the form of ByteDoublePair.
     *
     * @see #put(byte, double)
     * @since 9.1.0
     */
    default void putPair(ByteDoublePair keyValuePair)
    {
        this.put(keyValuePair.getOne(), keyValuePair.getTwo());
    }

    void putAll(ByteDoubleMap 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(ByteDoubleToDoubleFunction function);

    void removeKey(byte key);

    void remove(byte key);

    double removeKeyIfAbsent(byte key, double value);

    double getIfAbsentPut(byte key, double value);

    double getIfAbsentPut(byte key, DoubleFunction0 function);

    double getIfAbsentPutWithKey(byte key, ByteToDoubleFunction function);

     double getIfAbsentPutWith(byte key, DoubleFunction function, P parameter);

    double updateValue(byte key, double initialValueIfAbsent, DoubleToDoubleFunction function);

    @Override
    MutableDoubleByteMap flipUniqueValues();

    @Override
    MutableByteDoubleMap select(ByteDoublePredicate predicate);

    @Override
    MutableByteDoubleMap reject(ByteDoublePredicate predicate);

    MutableByteDoubleMap withKeyValue(byte key, double value);

    MutableByteDoubleMap withoutKey(byte key);

    MutableByteDoubleMap withoutAllKeys(ByteIterable keys);

    default MutableByteDoubleMap withAllKeyValues(Iterable keyValuePairs)
    {
        for (ByteDoublePair keyValuePair : keyValuePairs)
        {
            this.putPair(keyValuePair);
        }
        return this;
    }

    MutableByteDoubleMap asUnmodifiable();

    MutableByteDoubleMap asSynchronized();

    double addToValue(byte key, double toBeAdded);
}