com.mojang.datafixers.util

Class Pair<F,S>

java.lang.Object

com.mojang.datafixers.util.Pair<F,S>

Type Parameters:

F - The type of the first value.

S - The type of the second value.

All Implemented Interfaces:

(F,S)

public class Pair<F,S>
extends Object

A product type containing two values.

Type Shape:

"(%0%.,.%1)"

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pair.Instance<S2> The CartesianLike type class instance for Pair.
static class	Pair.Mu<S> The witness type for Pair.

Constructor Summary

Constructors

Constructor and Description
Pair(F first, S second) Constructs a pair with the given values.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
F	getFirst() The first value.
S	getSecond() The second value.
int	hashCode()
<F2> (F2,S)	mapFirst((? super F) -> ? extends F2 function) Transforms the first element of this pair to another type.
<S2> (F,S2)	mapSecond((? super S) -> ? extends S2 function) Transforms the second element of this pair to another type.
static <F,S> (F,S)	of(F first, S second) Creates a pair with the given values.
(S,F)	swap() Returns a pair with the elements of this pair swapped.
static <F,S> Collector<(F,S),?,Map<F,S>>	toMap() Returns a Collector that collects pairs into a Map, using the first value as the key in the map and the second value as the value in the map.
String	toString()
static <F,S> (F,S)	unbox((F,S) box) Thunk method to cast an applied Pair.Mu to a Pair.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Pair

public Pair(F first,
            S second)

Constructs a pair with the given values.

Parameters:

first - The first value.

second - The second value.

See Also:

of(Object, Object)

Method Detail

unbox

public static <F,S> (F,S) unbox((F,S) box)

Thunk method to cast an applied Pair.Mu to a Pair.

Type Parameters:

F - The type of the first value.

S - The type of the second value.

Parameters:

box - The boxed pair.

Returns:

The unboxed pair.

getFirst

public F getFirst()

The first value.

getSecond

public S getSecond()

The second value.

swap

public (S,F) swap()

Returns a pair with the elements of this pair swapped.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

mapFirst

public <F2> (F2,S) mapFirst((? super F) -> ? extends F2 function)

Transforms the first element of this pair to another type.

API Note:

This method implements the functor operator for the first element of Pair.

Type Parameters:

F2 - The new type of the first element.

Parameters:

function - The transformation.

Returns:

A pair with the transformed first element.

See Also:

Pair.Instance.map(Function, App)

mapSecond

public <S2> (F,S2) mapSecond((? super S) -> ? extends S2 function)

Transforms the second element of this pair to another type.

API Note:

This method implements the functor operator for the second element of Pair.

Type Parameters:

S2 - The new type of the second element.

Parameters:

function - The transformation.

Returns:

A pair with the transformed second element.

of

public static <F,S> (F,S) of(F first,
                             S second)

Creates a pair with the given values.

Type Parameters:

F - The type of the first value.

S - The type of the second value.

Parameters:

first - The first value.

second - The second value.

Returns:

A pair containing the given values.

toMap

public static <F,S> Collector<(F,S),?,Map<F,S>> toMap()

Returns a Collector that collects pairs into a Map, using the first value as the key in the map and the second value as the value in the map.

Type Parameters:

F - The type of the first value.

S - The type of the second value.

Returns:

A Collector that transforms a stream of Pair into a Map.