org.eclipse.collections.api.map.primitive.MutableCharObjectMap 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.CharIterable;
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.CharToObjectFunction;
import org.eclipse.collections.api.block.predicate.primitive.CharObjectPredicate;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.tuple.primitive.CharObjectPair;

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

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

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

    V removeKey(char key);

    V remove(char key);

    V getIfAbsentPut(char key, V value);

    V getIfAbsentPut(char key, Function0 function);

    V getIfAbsentPutWithKey(char key, CharToObjectFunction function);

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

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

    @Override
    MutableObjectCharMap flipUniqueValues();

    @Override
    MutableCharObjectMap tap(Procedure procedure);

    @Override
    MutableCharObjectMap select(CharObjectPredicate predicate);

    @Override
    MutableCharObjectMap reject(CharObjectPredicate predicate);

    MutableCharObjectMap withKeyValue(char key, V value);

    MutableCharObjectMap withoutKey(char key);

    MutableCharObjectMap withoutAllKeys(CharIterable keys);

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

    MutableCharObjectMap asUnmodifiable();

    MutableCharObjectMap asSynchronized();
}