org.eclipse.collections.api.map.primitive.MutableObjectCharMap 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 and others.
 * 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.block.function.primitive.CharFunction;
import org.eclipse.collections.api.block.function.primitive.CharFunction0;
import org.eclipse.collections.api.block.function.primitive.CharToCharFunction;
import org.eclipse.collections.api.block.function.primitive.CharToObjectFunction;
import org.eclipse.collections.api.block.function.primitive.ObjectCharToCharFunction;
import org.eclipse.collections.api.block.predicate.primitive.CharPredicate;
import org.eclipse.collections.api.block.procedure.primitive.CharProcedure;
import org.eclipse.collections.api.block.predicate.primitive.ObjectCharPredicate;
import org.eclipse.collections.api.collection.MutableCollection;
import org.eclipse.collections.api.collection.primitive.MutableCharCollection;
import org.eclipse.collections.api.iterator.MutableCharIterator;
import org.eclipse.collections.api.tuple.primitive.ObjectCharPair;

/**
 * This file was automatically generated from template file mutableObjectPrimitiveMap.stg.
 *
 * @since 3.0.
 */
public interface MutableObjectCharMap extends ObjectCharMap
{
    @Override
    MutableCharIterator charIterator();

    void clear();

    void put(K key, char value);

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

    void putAll(ObjectCharMap 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(ObjectCharToCharFunction function);

    void removeKey(K key);

    void remove(Object key);

    char removeKeyIfAbsent(K key, char value);

    char getIfAbsentPut(K key, char value);

    char getIfAbsentPut(K key, CharFunction0 function);

    char getIfAbsentPutWithKey(K key, CharFunction function);

     char getIfAbsentPutWith(K key, CharFunction function, P parameter);

    char updateValue(K key, char initialValueIfAbsent, CharToCharFunction function);

    @Override
    MutableCharObjectMap flipUniqueValues();

    @Override
    MutableObjectCharMap select(ObjectCharPredicate predicate);

    @Override
    MutableObjectCharMap reject(ObjectCharPredicate predicate);

    @Override
    MutableCharCollection select(CharPredicate predicate);

    @Override
    MutableCharCollection reject(CharPredicate predicate);

    /**
     * @since 9.0.
     */
    default MutableObjectCharMap tap(CharProcedure procedure)
    {
        this.forEach(procedure);
        return this;
    }

    @Override
     MutableCollection collect(CharToObjectFunction function);

    MutableObjectCharMap withKeyValue(K key, char value);

    MutableObjectCharMap withoutKey(K key);

    MutableObjectCharMap withoutAllKeys(Iterable keys);

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

    MutableObjectCharMap asUnmodifiable();

    MutableObjectCharMap asSynchronized();

    char addToValue(K key, char toBeAdded);
}