org.eclipse.collections.api.map.primitive.IntObjectMap 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.
 * 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.LazyIntIterable;
import org.eclipse.collections.api.RichIterable;
import org.eclipse.collections.api.block.function.Function0;
import org.eclipse.collections.api.block.predicate.primitive.IntObjectPredicate;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.block.procedure.primitive.IntObjectProcedure;
import org.eclipse.collections.api.block.procedure.primitive.IntProcedure;
import org.eclipse.collections.api.set.primitive.MutableIntSet;
import org.eclipse.collections.api.tuple.primitive.IntObjectPair;

/**
 * This file was automatically generated from template file primitiveObjectMap.stg.
 *
 * @since 3.0.
 */
public interface IntObjectMap extends PrimitiveObjectMap
{
    V get(int key);

    V getIfAbsent(int key, Function0 ifAbsent);

    boolean containsKey(int key);

    @Override
    IntObjectMap tap(Procedure procedure);

    void forEachKey(IntProcedure procedure);

    void forEachKeyValue(IntObjectProcedure procedure);

    IntObjectMap select(IntObjectPredicate predicate);

    IntObjectMap reject(IntObjectPredicate predicate);

    ImmutableIntObjectMap toImmutable();

    MutableIntSet keySet();

    /**
     * @since 5.0
     */
    LazyIntIterable keysView();

    /**
     * @since 5.0
     */
    RichIterable> keyValuesView();

    /**
     * Return the ObjectIntMap that is obtained by flipping the direction of this map and making the associations
     * from value to key.
     *
     * @throws IllegalStateException if the ObjectIntMap contains duplicate values.
     * @since 9.0
     */
    ObjectIntMap flipUniqueValues();
}