org.eclipse.collections.api.map.primitive.MutableObjectLongMap 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.LongFunction;
import org.eclipse.collections.api.block.function.primitive.LongFunction0;
import org.eclipse.collections.api.block.function.primitive.LongToLongFunction;
import org.eclipse.collections.api.block.function.primitive.LongToObjectFunction;
import org.eclipse.collections.api.block.function.primitive.ObjectLongToLongFunction;
import org.eclipse.collections.api.block.predicate.primitive.LongPredicate;
import org.eclipse.collections.api.block.procedure.primitive.LongProcedure;
import org.eclipse.collections.api.block.predicate.primitive.ObjectLongPredicate;
import org.eclipse.collections.api.collection.MutableCollection;
import org.eclipse.collections.api.collection.primitive.MutableLongCollection;
import org.eclipse.collections.api.iterator.MutableLongIterator;
import org.eclipse.collections.api.tuple.primitive.ObjectLongPair;

/**
 * This file was automatically generated from template file mutableObjectPrimitiveMap.stg.
 *
 * @since 3.0.
 */
public interface MutableObjectLongMap extends ObjectLongMap
{
    @Override
    MutableLongIterator longIterator();

    void clear();

    void put(K key, long value);

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

    void putAll(ObjectLongMap 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(ObjectLongToLongFunction function);

    void removeKey(K key);

    void remove(Object key);

    long removeKeyIfAbsent(K key, long value);

    long getIfAbsentPut(K key, long value);

    long getIfAbsentPut(K key, LongFunction0 function);

    long getIfAbsentPutWithKey(K key, LongFunction function);

     long getIfAbsentPutWith(K key, LongFunction function, P parameter);

    long updateValue(K key, long initialValueIfAbsent, LongToLongFunction function);

    @Override
    MutableLongObjectMap flipUniqueValues();

    @Override
    MutableObjectLongMap select(ObjectLongPredicate predicate);

    @Override
    MutableObjectLongMap reject(ObjectLongPredicate predicate);

    @Override
    MutableLongCollection select(LongPredicate predicate);

    @Override
    MutableLongCollection reject(LongPredicate predicate);

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

    @Override
     MutableCollection collect(LongToObjectFunction function);

    MutableObjectLongMap withKeyValue(K key, long value);

    MutableObjectLongMap withoutKey(K key);

    MutableObjectLongMap withoutAllKeys(Iterable keys);

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

    MutableObjectLongMap asUnmodifiable();

    MutableObjectLongMap asSynchronized();

    long addToValue(K key, long toBeAdded);
}