/*
 * 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.IntIterable;
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.IntToObjectFunction;
import org.eclipse.collections.api.block.predicate.primitive.IntObjectPredicate;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.tuple.primitive.IntObjectPair;

This file was automatically generated from template file mutablePrimitiveObjectMap.stg.
Since:
3.0./**
 * This file was automatically generated from template file mutablePrimitiveObjectMap.stg.
 *
 * @since 3.0.
 */
public interface MutableIntObjectMap<V> extends IntObjectMap<V>, MutablePrimitiveObjectMap<V>
{
    
Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value. 
Params:
key – the key
value – the value to associate with value
Returns:
the value previously associated with key if one existed, or null if not/**
     * Associates a value with the specified key. If a value is already associated
     * with the key in this map, it will be replaced with {@code value}.
     * @param key the key
     * @param value the value to associate with {@code value}
     * @return the value previously associated with {@code key} if one existed, or
     * {@code null} if not
     */
    V put(int key, V value);

    
This method allows MutableIntObjectMap the ability to add an element in the form of IntObjectPair<V>. 
See Also:
put(int, Object)
Since:
9.1.0/**
     * This method allows MutableIntObjectMap the ability to add an element in the form of {@code IntObjectPair<V>}.
     *
     * @see #put(int, Object)
     * @since 9.1.0
     */
    default V putPair(IntObjectPair<V> keyValuePair)
    {
        return this.put(keyValuePair.getOne(), keyValuePair.getTwo());
    }

    
Puts all of the key/value mappings from the specified map into this map. If this map already has a value associated with one of the keys in the map, it will be replaced with the value in map. 
Params:
map – the map to copy into this map
Since:
5.0./**
     * Puts all of the key/value mappings from the specified map into this map. If this
     * map already has a value associated with one of the keys in the map, it will be
     * replaced with the value in {@code map}.
     * @param map the map to copy into this map
     * @since 5.0.
     */
    void putAll(IntObjectMap<? extends V> map);

    
Removes the mapping associated with the key, if one exists, from the map.
Params:
key – the key to remove
See Also:
remove(int)/**
     * Removes the mapping associated with the key, if one exists, from the map.
     * @param key the key to remove
     * @see #remove(int)
     */
    V removeKey(int key);

    
Removes the mapping associated with the key, if one exists, from the map.
Params:
key – the key to remove
See Also:
removeKey(int)/**
     * Removes the mapping associated with the key, if one exists, from the map.
     * @param key the key to remove
     * @see #removeKey(int)
     */
    V remove(int key);

    
Retrieves the value associated with the key if one exists; if it does not,
associates a value with the key.
Params:
key – the key
value – the value to associate with key if no such mapping exists
Returns:
the value associated with key, if one exists, or value if not/**
     * Retrieves the value associated with the key if one exists; if it does not,
     * associates a value with the key.
     * @param key the key
     * @param value the value to associate with {@code key} if no such mapping exists
     * @return the value associated with key, if one exists, or {@code value} if not
     */
    V getIfAbsentPut(int key, V value);

    
Retrieves the value associated with the key if one exists; if it does not,
invokes the supplier and associates the result with the key.
Params:
key – the key
function – the supplier that provides the value if no mapping exists for key
Returns:
the value associated with the key, if one exists, or the result of invoking function if not/**
     * Retrieves the value associated with the key if one exists; if it does not,
     * invokes the supplier and associates the result with the key.
     * @param key the key
     * @param function the supplier that provides the value if no mapping exists for {@code key}
     * @return the value associated with the key, if one exists, or the result of
     * invoking {@code function} if not
     */
    V getIfAbsentPut(int key, Function0<? extends V> function);

    
Retrieves the value associated with the key if one exists; if it does not,
associates the result of invoking the value function with the key.
Params:
key – the key
function – the function that provides the value if no mapping exists. The key will be passed as the argument to the function.
Returns:
the value associated with the key, if one exists, or the result of invoking function with key if not/**
     * Retrieves the value associated with the key if one exists; if it does not,
     * associates the result of invoking the value function with the key.
     * @param key the key
     * @param function the function that provides the value if no mapping exists.
     * The {@code key} will be passed as the argument to the function.
     * @return the value associated with the key, if one exists, or the result of
     * invoking {@code function} with {@code key} if not
     */
    V getIfAbsentPutWithKey(int key, IntToObjectFunction<? extends V> function);

    
Retrieves the value associated with the key if one exists; if it does not,
invokes the value function with the parameter and associates the result with the key.
Params:
key – the key
function – the function that provides the value if no mapping exists. The specified parameter will be passed as the argument to the function.
parameter – the parameter to provide to function if no value exists for key
Type parameters:
<P> – the type of the value function's parameter
Returns:
the value associated with the key, if one exists, or the result of invoking function with parameter if not/**
     * Retrieves the value associated with the key if one exists; if it does not,
     * invokes the value function with the parameter and associates the result with the key.
     * @param key the key
     * @param function the function that provides the value if no mapping exists.
     * The specified {@code parameter} will be passed as the argument to the function.
     * @param parameter the parameter to provide to {@code function} if no value
     * exists for {@code key}
     * @param <P> the type of the value function's {@code parameter}
     * @return the value associated with the key, if one exists, or the result of
     * invoking {@code function} with {@code parameter} if not
     */
    <P> V getIfAbsentPutWith(int key, Function<? super P, ? extends V> function, P parameter);

    
Look up the value associated with key, apply the function to it, and replace the value. If there is no value associated with key, start it off with a value supplied by factory. /**
     * 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(int key, Function0<? extends V> factory, Function<? super V, ? extends V> function);

    
Updates or sets the value associated with the key by applying the function to the
existing value, if one exists, or the initial value supplied by the factory if one does not.
Params:
key – the key
factory – the supplier providing the initial value to the function if no
mapping exists for the key
function – the function that returns the updated value based on the current value or the initial value, if no value exists. The specified parameter will also be passed as the second argument to the function.
parameter – the parameter to provide to function if no value exists for key
Type parameters:
<P> – the type of the value function's parameter
Returns:
the new value associated with the key, either as a result of applying function to the value already associated with the key or as a result of applying it to the value returned by factory and associating the result with key/**
     * Updates or sets the value associated with the key by applying the function to the
     * existing value, if one exists, or the initial value supplied by the factory if one does not.
     * @param key the key
     * @param factory the supplier providing the initial value to the function if no
     * mapping exists for the key
     * @param function the function that returns the updated value based on the current
     * value or the initial value, if no value exists. The specified {@code parameter}
     * will also be passed as the second argument to the function.
     * @param parameter the parameter to provide to {@code function} if no value
     * exists for {@code key}
     * @param <P> the type of the value function's {@code parameter}
     * @return the new value associated with the key, either as a result of applying
     * {@code function} to the value already associated with the key or as a result of
     * applying it to the value returned by {@code factory} and associating the result
     * with {@code key}
     */
    <P> V updateValueWith(int key, Function0<? extends V> factory, Function2<? super V, ? super P, ? extends V> function, P parameter);

    @Override
    MutableObjectIntMap<V> flipUniqueValues();

    @Override
    MutableIntObjectMap<V> tap(Procedure<? super V> procedure);

    @Override
    MutableIntObjectMap<V> select(IntObjectPredicate<? super V> predicate);

    @Override
    MutableIntObjectMap<V> reject(IntObjectPredicate<? super V> predicate);

    
Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value. 
Params:
key – the key
value – the value to associate with value
See Also:
put(int, Object)
Returns:
this map/**
     * Associates a value with the specified key. If a value is already associated
     * with the key in this map, it will be replaced with {@code value}.
     * @param key the key
     * @param value the value to associate with {@code value}
     * @return this map
     * @see #put(int, V)
     */
    MutableIntObjectMap<V> withKeyValue(int key, V value);

    
Removes the mapping associated with the key, if one exists, from this map.
Params:
key – the key to remove
See Also:
remove(int)
Returns:
this map/**
     * Removes the mapping associated with the key, if one exists, from this map.
     * @param key the key to remove
     * @return this map
     * @see #remove(int)
     */
    MutableIntObjectMap<V> withoutKey(int key);

    
Removes the mappings associated with all the keys, if they exist, from this map.
Params:
keys – the keys to remove
See Also:
remove(int)
Returns:
this map/**
     * Removes the mappings associated with all the keys, if they exist, from this map.
     * @param keys the keys to remove
     * @return this map
     * @see #remove(int)
     */
    MutableIntObjectMap<V> withoutAllKeys(IntIterable keys);

    
Puts all of the key/value mappings from the specified pairs into this map. If this
map already has a value associated with one of the keys in the pairs, it will be
replaced with the value in the pair.
Params:
iterable – the pairs to put into this map
See Also:
putPair(IntObjectPair)
Returns:
this map/**
     * Puts all of the key/value mappings from the specified pairs into this map. If this
     * map already has a value associated with one of the keys in the pairs, it will be
     * replaced with the value in the pair.
     * @param iterable the pairs to put into this map
     * @return this map
     * @see #putPair(IntObjectPair)
     */
    default MutableIntObjectMap<V> withAllKeyValues(Iterable<IntObjectPair<V>> keyValuePairs)
    {
        for (IntObjectPair<V> keyValuePair : keyValuePairs)
        {
            this.putPair(keyValuePair);
        }
        return this;
    }

    
Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations. This avoids the overhead of copying the map when calling IntObjectMap.toImmutable() while still providing immutability. 
Returns:
an unmodifiable view of this map/**
     * Returns an unmodifiable view of this map, delegating all read-only operations to this
     * map and throwing an {@link UnsupportedOperationException} for all mutating operations.
     * This avoids the overhead of copying the map when calling {@link #toImmutable()} while
     * still providing immutability.
     * @return an unmodifiable view of this map
     */
    MutableIntObjectMap<V> asUnmodifiable();

    
Returns a synchronized view of this map, delegating all operations to this map but
ensuring only one caller has access to the map at a time.
Returns:
a synchronized view of this map/**
     * Returns a synchronized view of this map, delegating all operations to this map but
     * ensuring only one caller has access to the map at a time.
     * @return a synchronized view of this map
     */
    MutableIntObjectMap<V> asSynchronized();
}