com.gs.collections.api.factory.map.ImmutableMapFactory Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Goldman Sachs.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.gs.collections.api.factory.map;

import java.util.Map;

import com.gs.collections.api.map.ImmutableMap;

public interface ImmutableMapFactory
{
    /**
     * @since 6.0
     */
     ImmutableMap empty();

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

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

    /**
     * Same as {@link #with(Object, Object)}.
     */
     ImmutableMap of(K key, V value);

     ImmutableMap with(K key, V value);

    /**
     * Same as {@link #with(Object, Object, Object, Object)}.
     */
     ImmutableMap of(K key1, V value1, K key2, V value2);

     ImmutableMap with(K key1, V value1, K key2, V value2);

    /**
     * Same as {@link #with(Object, Object, Object, Object, Object, Object)}.
     */
     ImmutableMap of(K key1, V value1, K key2, V value2, K key3, V value3);

     ImmutableMap with(K key1, V value1, K key2, V value2, K key3, V value3);

    /**
     * Same as {@link #with(Object, Object, Object, Object, Object, Object, Object, Object)}.
     */
     ImmutableMap of(K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4);

     ImmutableMap with(K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4);

     ImmutableMap ofMap(Map map);

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

     ImmutableMap withAll(Map map);
}