org.eclipse.collections.api.map.primitive.MutableCharIntMap 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.primitive.CharToIntFunction;
import org.eclipse.collections.api.block.function.primitive.IntFunction;
import org.eclipse.collections.api.block.function.primitive.IntFunction0;
import org.eclipse.collections.api.block.function.primitive.IntToIntFunction;
import org.eclipse.collections.api.block.function.primitive.CharIntToIntFunction;
import org.eclipse.collections.api.block.predicate.primitive.CharIntPredicate;
import org.eclipse.collections.api.tuple.primitive.CharIntPair;

/**
 * This file was automatically generated from template file mutablePrimitivePrimitiveMap.stg.
 *
 * @since 3.0.
 */
public interface MutableCharIntMap extends CharIntMap, MutableIntValuesMap
{
    void put(char key, int value);

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

    void putAll(CharIntMap 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(CharIntToIntFunction function);

    void removeKey(char key);

    void remove(char key);

    int removeKeyIfAbsent(char key, int value);

    int getIfAbsentPut(char key, int value);

    int getIfAbsentPut(char key, IntFunction0 function);

    int getIfAbsentPutWithKey(char key, CharToIntFunction function);

     int getIfAbsentPutWith(char key, IntFunction function, P parameter);

    int updateValue(char key, int initialValueIfAbsent, IntToIntFunction function);

    @Override
    MutableIntCharMap flipUniqueValues();

    @Override
    MutableCharIntMap select(CharIntPredicate predicate);

    @Override
    MutableCharIntMap reject(CharIntPredicate predicate);

    MutableCharIntMap withKeyValue(char key, int value);

    MutableCharIntMap withoutKey(char key);

    MutableCharIntMap withoutAllKeys(CharIterable keys);

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

    MutableCharIntMap asUnmodifiable();

    MutableCharIntMap asSynchronized();

    int addToValue(char key, int toBeAdded);
}