org.eclipse.collections.api.map.primitive.FloatObjectMap 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) 2015 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 java.util.Collection;
import java.util.Map;

import org.eclipse.collections.api.LazyFloatIterable;
import org.eclipse.collections.api.RichIterable;
import org.eclipse.collections.api.block.function.Function0;
import org.eclipse.collections.api.block.predicate.primitive.FloatObjectPredicate;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.block.procedure.primitive.FloatObjectProcedure;
import org.eclipse.collections.api.block.procedure.primitive.FloatProcedure;
import org.eclipse.collections.api.set.primitive.MutableFloatSet;
import org.eclipse.collections.api.tuple.primitive.FloatObjectPair;

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

    V getIfAbsent(float key, Function0 ifAbsent);

    boolean containsKey(float key);

    boolean containsValue(Object value);

    FloatObjectMap tap(Procedure procedure);

    void forEachValue(Procedure procedure);

    void forEachKey(FloatProcedure procedure);

    void forEachKeyValue(FloatObjectProcedure procedure);

    FloatObjectMap select(FloatObjectPredicate predicate);

    FloatObjectMap reject(FloatObjectPredicate predicate);

    /**
     * Follows the same general contract as {@link Map#equals(Object)}.
     */
    @Override
    boolean equals(Object o);

    /**
     * Follows the same general contract as {@link Map#hashCode()}.
     */
    @Override
    int hashCode();

    /**
     * Returns a string representation of this FloatObjectMap. The string representation consists of a list of the
     * map's key-value pairs in the order they are returned by its iterator. The key and value in each key-value pair are separated
     * by a colon (":") and each pair is enclosed in square brackets ("[]"). Adjacent key-value pairs
     * are separated by the characters ", " (comma and space). Keys and values are converted to strings as by
     * String#valueOf().
     *
     * @return a string representation of this FloatObjectMap
     */
    String toString();

    ImmutableFloatObjectMap toImmutable();

    MutableFloatSet keySet();

    Collection values();

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

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