org.eclipse.collections.impl.tuple.Tuples Maven / Gradle / Ivy

Go to download

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

There is a newer version: 12.0.0.M3

/*
 * 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.impl.tuple;

import java.util.Map;

import org.eclipse.collections.api.tuple.Pair;
import org.eclipse.collections.api.tuple.Twin;

/**
 * A Pair is a container that holds two related objects.  It is the equivalent of an Association in Smalltalk, or an
 * implementation of Map.Entry in the JDK.  A Twin is a Pair with the same types.  This class is a factory class
 * for Pairs and Twins.
 */
public final class Tuples
{
    private Tuples()
    {
    }

    public static  Pair pairFrom(Map.Entry entry)
    {
        return Tuples.pair(entry.getKey(), entry.getValue());
    }

    public static  Pair pair(T1 one, T2 two)
    {
        return new PairImpl(one, two);
    }

    public static  Twin twin(T one, T two)
    {
        return new TwinImpl(one, two);
    }
}