/*
 * Copyright (c) 2020 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.CharToObjectFunction;
import org.eclipse.collections.api.block.predicate.primitive.ObjectCharPredicate;
import org.eclipse.collections.api.block.predicate.primitive.CharPredicate;
import org.eclipse.collections.api.block.procedure.primitive.CharProcedure;
import org.eclipse.collections.api.collection.ImmutableCollection;
import org.eclipse.collections.api.collection.primitive.ImmutableCharCollection;

This file was automatically generated from template file immutableObjectPrimitiveMap.stg.
Since:
3.0./**
 * This file was automatically generated from template file immutableObjectPrimitiveMap.stg.
 *
 * @since 3.0.
 */
public interface ImmutableObjectCharMap<K> extends ObjectCharMap<K>
{
    @Override
    ImmutableObjectCharMap<K> select(ObjectCharPredicate<? super K> predicate);

    @Override
    ImmutableObjectCharMap<K> reject(ObjectCharPredicate<? super K> predicate);

    @Override
    ImmutableCharCollection select(CharPredicate predicate);

    @Override
    ImmutableCharCollection reject(CharPredicate predicate);

    
Since:
9.0./**
     * @since 9.0.
     */
    @Override
    default ImmutableObjectCharMap<K> tap(CharProcedure procedure)
    {
        this.forEach(procedure);
        return this;
    }

    @Override
    <V> ImmutableCollection<V> collect(CharToObjectFunction<? extends V> function);

    
Copy this map, associate the value with the key (replacing the value if one already exists for key), and return the copy as new immutable map. A copy is always made even if key is already associated with value. 
Params:
key – the key to add
value – the value to associate with the key in the copy
Returns:
an immutable copy of this map with value associated with key/**
     * Copy this map, associate the value with the key (replacing the value if one
     * already exists for {@code key}), and return the copy as new immutable map.
     * A copy is always made even if {@code key} is already associated with {@code value}.
     * @param key the key to add
     * @param value the value to associate with the key in the copy
     * @return an immutable copy of this map with {@code value} associated with {@code key}
     */
    ImmutableObjectCharMap<K> newWithKeyValue(K key, char value);

    
Copy this map, remove any associated value with the key (if one exists), and
return the copy as a new immutable map.
Params:
key – the key to remove
Returns:
an immutable copy of this map with key removed/**
     * Copy this map, remove any associated value with the key (if one exists), and
     * return the copy as a new immutable map.
     * @param key the key to remove
     * @return an immutable copy of this map with {@code key} removed
     */
    ImmutableObjectCharMap<K> newWithoutKey(K key);

    
Copy this map, remove any associated values with the specified keys (if any exist),
and return the copy as a new immutable map.
Params:
keys – the keys to remove
Returns:
an immutable copy of this map with all keys in keys removed/**
     * Copy this map, remove any associated values with the specified keys (if any exist),
     * and return the copy as a new immutable map.
     * @param keys the keys to remove
     * @return an immutable copy of this map with all keys in {@code keys} removed
     */
    ImmutableObjectCharMap<K> newWithoutAllKeys(Iterable<? extends K> keys);

    @Override
    ImmutableCharObjectMap<K> flipUniqueValues();
}