com.gs.collections.impl.factory.Maps Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gs-collections Show documentation

GS Collections is a collections framework for Java. It has JDK-compatible List, Set and Map implementations with a rich API and set of utility classes that work with any JDK compatible Collections, Arrays, Maps or Strings. The iteration protocol was inspired by the Smalltalk collection framework.

There is a newer version: 7.0.3

Show newest version

/*
 * Copyright 2015 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.impl.factory;

import com.gs.collections.api.factory.map.FixedSizeMapFactory;
import com.gs.collections.api.factory.map.ImmutableMapFactory;
import com.gs.collections.api.factory.map.MutableMapFactory;
import com.gs.collections.impl.map.fixed.FixedSizeMapFactoryImpl;
import com.gs.collections.impl.map.immutable.ImmutableMapFactoryImpl;
import com.gs.collections.impl.map.mutable.MutableMapFactoryImpl;

/**
 * This class should be used to create instances of MutableMap, ImmutableMap and FixedSizeMap
 * 
 * Mutable Examples:
 *
 * 
 * MutableMap<String, String> emptyMap = Maps.mutable.empty();
 * MutableMap<String, String> mapWith = Maps.mutable.with("a", "A", "b", "B", "c", "C");
 * MutableMap<String, String> mapOf = Maps.mutable.of("a", "A", "b", "B", "c", "C");
 * 
 *
 * Immutable Examples:
 *
 *  * ImmutableMap<String> mapList = Maps.immutable.empty();
 * ImmutableMap<String> mapWith = Maps.immutable.with("a", "A", "b", "B", "c", "C");
 * ImmutableMap<String> mapOf = Maps.immutable.of("a", "A", "b", "B", "c", "C");
 * 
 *
 * FixedSize Examples:
 *
 *  * FixedSizeMap<String> emptyList = Maps.fixedSize.empty();
 * FixedSizeMap<String> listWith = Maps.fixedSize.with("a", "A", "b", "B", "c", "C");
 * FixedSizeMap<String> listOf = Maps.fixedSize.of("a", "A", "b", "B", "c", "C");
 * 
 */
@SuppressWarnings("ConstantNamingConvention")
public final class Maps
{
    public static final ImmutableMapFactory immutable = new ImmutableMapFactoryImpl();
    public static final FixedSizeMapFactory fixedSize = new FixedSizeMapFactoryImpl();
    public static final MutableMapFactory mutable = new MutableMapFactoryImpl();

    private Maps()
    {
        throw new AssertionError("Suppress default constructor for noninstantiability");
    }
}