org.eclipse.collections.api.factory.map.primitive.MutableObjectDoubleMapFactory Maven / Gradle / Ivy

/*
 * 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.factory.map.primitive;

import org.eclipse.collections.api.block.function.Function;
import org.eclipse.collections.api.block.function.primitive.DoubleFunction;
import org.eclipse.collections.api.map.primitive.MutableObjectDoubleMap;
import org.eclipse.collections.api.map.primitive.ObjectDoubleMap;

/**
 * A factory which creates instances of type {@link MutableObjectDoubleMap}.
 * This file was automatically generated from template file mutableObjectPrimitiveMapFactory.stg.
 *
 * @since 6.0.
 */
public interface MutableObjectDoubleMapFactory
{
     MutableObjectDoubleMap empty();

    /**
     * Same as {@link #empty()}.
     */
     MutableObjectDoubleMap of();

    /**
     * Same as {@link #empty()}.
     */
     MutableObjectDoubleMap with();

    /**
     * Same as {@link #empty()}. but takes in an initial capacity
     */
     MutableObjectDoubleMap ofInitialCapacity(int capacity);

    /**
     * Same as {@link #empty()}. but takes in an initial capacity
     */
     MutableObjectDoubleMap withInitialCapacity(int capacity);

    /**
     * Same as {@link #withAll(ObjectDoubleMap)}.
     */
     MutableObjectDoubleMap ofAll(ObjectDoubleMap  map);

     MutableObjectDoubleMap withAll(ObjectDoubleMap  map);

    /**
     * Creates an {@code MutableObjectDoubleMap} from an {@code Iterable} by applying {@code keyFunction} and {@code valueFunction}.
     *
     * @since 10.0
     */
     MutableObjectDoubleMap from(Iterable iterable, Function keyFunction, DoubleFunction valueFunction);
}