com.gs.collections.api.map.primitive.MutableCharObjectMap 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.CharIterable;
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.CharToObjectFunction;
import com.gs.collections.api.block.predicate.primitive.CharObjectPredicate;

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

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

    MutableCharObjectMap select(CharObjectPredicate predicate);

    MutableCharObjectMap reject(CharObjectPredicate predicate);

    MutableCharObjectMap withKeyValue(char key, V value);

    MutableCharObjectMap withoutKey(char key);

    MutableCharObjectMap withoutAllKeys(CharIterable keys);

    MutableCharObjectMap asUnmodifiable();

    MutableCharObjectMap asSynchronized();
}