com.gs.collections.api.map.primitive.MutableDoubleObjectMap Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Goldman Sachs.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.gs.collections.api.map.primitive;

import com.gs.collections.api.DoubleIterable;
import com.gs.collections.api.block.function.Function;
import com.gs.collections.api.block.function.Function0;
import com.gs.collections.api.block.function.Function2;
import com.gs.collections.api.block.function.primitive.DoubleToObjectFunction;
import com.gs.collections.api.block.predicate.primitive.DoubleObjectPredicate;

/**
 * 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);

    /**
     * @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);

    MutableDoubleObjectMap select(DoubleObjectPredicate predicate);

    MutableDoubleObjectMap reject(DoubleObjectPredicate predicate);

    MutableDoubleObjectMap withKeyValue(double key, V value);

    MutableDoubleObjectMap withoutKey(double key);

    MutableDoubleObjectMap withoutAllKeys(DoubleIterable keys);

    MutableDoubleObjectMap asUnmodifiable();

    MutableDoubleObjectMap asSynchronized();
}