org.eclipse.collections.impl.tuple

Class Tuples

java.lang.Object

org.eclipse.collections.impl.tuple.Tuples

public final class Tuples
extends Object

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. A Triple is a container that holds three related objects. Similar to Haskell a Tuple is container that can contain 2 or more objects. The Triple is the implementation of the 3-tuple. A Triplet is a Triple with the same types. This class holds factory methods for Triples and Triplets The equivalent class for primitive and object combinations is PrimitiveTuples

Method Summary

Modifier and Type	Method and Description
static <T> Triplet<T>	identicalTriplet(T each) This method returns a Triplet where the three elements in the Triplet are the same as the input element.
static <T> Twin<T>	identicalTwin(T each) This method returns a Twin where both elements in the Twin are the same as the input element.
static <T1,T2> Pair<T1,T2>	pair(T1 one, T2 two)
static <K,V> Pair<K,V>	pairFrom(Map.Entry<K,V> entry)
static <T> FixedSizeList<T>	pairToFixedSizeList(Pair<T,T> pair)
static <T> ImmutableList<T>	pairToImmutableList(Pair<T,T> pair)
static <T> MutableList<T>	pairToList(Pair<T,T> pair)
static <T1,T2,T3> Triple<T1,T2,T3>	triple(T1 one, T2 two, T3 three)
static <T> Triplet<T>	triplet(T one, T two, T three)
static <T> FixedSizeList<T>	tripleToFixedSizeList(Triple<T,T,T> triple)
static <T> ImmutableList<T>	tripleToImmutableList(Triple<T,T,T> triple)
static <T> MutableList<T>	tripleToList(Triple<T,T,T> triple)
static <T> Twin<T>	twin(T one, T two)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

pairFrom

public static <K,V> Pair<K,V> pairFrom(Map.Entry<K,V> entry)

pairToList

public static <T> MutableList<T> pairToList(Pair<T,T> pair)

Since:

11.0

pairToFixedSizeList

public static <T> FixedSizeList<T> pairToFixedSizeList(Pair<T,T> pair)

Since:

11.0

pairToImmutableList

public static <T> ImmutableList<T> pairToImmutableList(Pair<T,T> pair)

Since:

11.0

tripleToList

public static <T> MutableList<T> tripleToList(Triple<T,T,T> triple)

Since:

11.0

tripleToFixedSizeList

public static <T> FixedSizeList<T> tripleToFixedSizeList(Triple<T,T,T> triple)

Since:

11.0

tripleToImmutableList

public static <T> ImmutableList<T> tripleToImmutableList(Triple<T,T,T> triple)

Since:

11.0

pair

public static <T1,T2> Pair<T1,T2> pair(T1 one,
                                       T2 two)

twin

public static <T> Twin<T> twin(T one,
                               T two)

identicalTwin

public static <T> Twin<T> identicalTwin(T each)

This method returns a Twin where both elements in the Twin are the same as the input element.

triple

public static <T1,T2,T3> Triple<T1,T2,T3> triple(T1 one,
                                                 T2 two,
                                                 T3 three)

triplet

public static <T> Triplet<T> triplet(T one,
                                     T two,
                                     T three)

identicalTriplet

public static <T> Triplet<T> identicalTriplet(T each)

This method returns a Triplet where the three elements in the Triplet are the same as the input element.