javaslang

Class Tuple3<T1,T2,T3>

java.lang.Object

javaslang.Tuple3<T1,T2,T3>

Type Parameters:

T1 - type of the 1st element

T2 - type of the 2nd element

T3 - type of the 3rd element

All Implemented Interfaces:

Serializable, Comparable<Tuple3<T1,T2,T3>>, Tuple

public final class Tuple3<T1,T2,T3>
extends Object
implements Tuple, Comparable<Tuple3<T1,T2,T3>>, Serializable

A tuple of three elements which can be seen as cartesian product of three components.

Since:

1.1.0

Author:

Daniel Dietrich

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
T1	_1 The 1st element of this tuple.
T2	_2 The 2nd element of this tuple.
T3	_3 The 3rd element of this tuple.

Fields inherited from interface javaslang.Tuple

MAX_ARITY

Constructor Summary

Constructors

Constructor and Description
Tuple3(T1 t1, T2 t2, T3 t3) Constructs a tuple of three elements.

Method Summary

Modifier and Type	Method and Description
T1	_1() Getter of the 1st element of this tuple.
T2	_2() Getter of the 2nd element of this tuple.
T3	_3() Getter of the 3rd element of this tuple.
<U> U	apply(Function3<? super T1,? super T2,? super T3,? extends U> f) Transforms this tuple to an object of type U.
int	arity() Returns the number of elements of this tuple.
static <T1,T2,T3> Comparator<Tuple3<T1,T2,T3>>	comparator(Comparator<? super T1> t1Comp, Comparator<? super T2> t2Comp, Comparator<? super T3> t3Comp)
int	compareTo(Tuple3<T1,T2,T3> that)
boolean	equals(Object o)
int	hashCode()
<U1,U2,U3> Tuple3<U1,U2,U3>	map(Function<? super T1,? extends U1> f1, Function<? super T2,? extends U2> f2, Function<? super T3,? extends U3> f3) Maps the components of this tuple using a mapper function for each component.
<U1,U2,U3> Tuple3<U1,U2,U3>	map(Function3<? super T1,? super T2,? super T3,Tuple3<U1,U2,U3>> mapper) Maps the components of this tuple using a mapper function.
<U> Tuple3<U,T2,T3>	map1(Function<? super T1,? extends U> mapper) Maps the 1st component of this tuple to a new value.
<U> Tuple3<T1,U,T3>	map2(Function<? super T2,? extends U> mapper) Maps the 2nd component of this tuple to a new value.
<U> Tuple3<T1,T2,U>	map3(Function<? super T3,? extends U> mapper) Maps the 3rd component of this tuple to a new value.
Seq<?>	toSeq() Converts this tuple to a sequence.
String	toString()
<U> U	transform(Function3<? super T1,? super T2,? super T3,? extends U> f) Deprecated. Use apply(Function3) instead, will be removed in 3.0.0
Tuple3<T1,T2,T3>	update1(T1 value) Sets the 1st element of this tuple to the given value.
Tuple3<T1,T2,T3>	update2(T2 value) Sets the 2nd element of this tuple to the given value.
Tuple3<T1,T2,T3>	update3(T3 value) Sets the 3rd element of this tuple to the given value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javaslang.Tuple

empty, fromEntry, narrow, narrow, narrow, narrow, narrow, narrow, narrow, narrow, of, of, of, of, of, of, of, of, sequence1, sequence2, sequence3, sequence4, sequence5, sequence6, sequence7, sequence8

Field Detail

_1

public final T1 _1

The 1st element of this tuple.

_2

public final T2 _2

The 2nd element of this tuple.

_3

public final T3 _3

The 3rd element of this tuple.

Constructor Detail

Tuple3

public Tuple3(T1 t1,
              T2 t2,
              T3 t3)

Constructs a tuple of three elements.

Parameters:

t1 - the 1st element

t2 - the 2nd element

t3 - the 3rd element

Method Detail

comparator

public static <T1,T2,T3> Comparator<Tuple3<T1,T2,T3>> comparator(Comparator<? super T1> t1Comp,
                                                                 Comparator<? super T2> t2Comp,
                                                                 Comparator<? super T3> t3Comp)

arity

public int arity()

Description copied from interface: Tuple

Returns the number of elements of this tuple.

Specified by:

arity in interface Tuple

Returns:

the number of elements.

compareTo

public int compareTo(Tuple3<T1,T2,T3> that)

Specified by:

compareTo in interface Comparable<Tuple3<T1,T2,T3>>

_1

public T1 _1()

Getter of the 1st element of this tuple.

Returns:

the 1st element of this Tuple.

update1

public Tuple3<T1,T2,T3> update1(T1 value)

Sets the 1st element of this tuple to the given value.

Parameters:

value - the new value

Returns:

a copy of this tuple with a new value for the 1st element of this Tuple.

_2

public T2 _2()

Getter of the 2nd element of this tuple.

Returns:

the 2nd element of this Tuple.

update2

public Tuple3<T1,T2,T3> update2(T2 value)

Sets the 2nd element of this tuple to the given value.

Parameters:

value - the new value

Returns:

a copy of this tuple with a new value for the 2nd element of this Tuple.

_3

public T3 _3()

Getter of the 3rd element of this tuple.

Returns:

the 3rd element of this Tuple.

update3

public Tuple3<T1,T2,T3> update3(T3 value)

Sets the 3rd element of this tuple to the given value.

Parameters:

value - the new value

Returns:

a copy of this tuple with a new value for the 3rd element of this Tuple.

map

public <U1,U2,U3> Tuple3<U1,U2,U3> map(Function3<? super T1,? super T2,? super T3,Tuple3<U1,U2,U3>> mapper)

Maps the components of this tuple using a mapper function.

Type Parameters:

U1 - new type of the 1st component

U2 - new type of the 2nd component

U3 - new type of the 3rd component

Parameters:

mapper - the mapper function

Returns:

A new Tuple of same arity.

Throws:

NullPointerException - if mapper is null

map

public <U1,U2,U3> Tuple3<U1,U2,U3> map(Function<? super T1,? extends U1> f1,
                                       Function<? super T2,? extends U2> f2,
                                       Function<? super T3,? extends U3> f3)

Maps the components of this tuple using a mapper function for each component.

Type Parameters:

U1 - new type of the 1st component

U2 - new type of the 2nd component

U3 - new type of the 3rd component

Parameters:

f1 - the mapper function of the 1st component

f2 - the mapper function of the 2nd component

f3 - the mapper function of the 3rd component

Returns:

A new Tuple of same arity.

Throws:

NullPointerException - if one of the arguments is null

map1

public <U> Tuple3<U,T2,T3> map1(Function<? super T1,? extends U> mapper)

Maps the 1st component of this tuple to a new value.

Type Parameters:

U - new type of the 1st component

Parameters:

mapper - A mapping function

Returns:

a new tuple based on this tuple and substituted 1st component

map2

public <U> Tuple3<T1,U,T3> map2(Function<? super T2,? extends U> mapper)

Maps the 2nd component of this tuple to a new value.

Type Parameters:

U - new type of the 2nd component

Parameters:

mapper - A mapping function

Returns:

a new tuple based on this tuple and substituted 2nd component

map3

public <U> Tuple3<T1,T2,U> map3(Function<? super T3,? extends U> mapper)

Maps the 3rd component of this tuple to a new value.

Type Parameters:

U - new type of the 3rd component

Parameters:

mapper - A mapping function

Returns:

a new tuple based on this tuple and substituted 3rd component

apply

public <U> U apply(Function3<? super T1,? super T2,? super T3,? extends U> f)

Transforms this tuple to an object of type U.

Type Parameters:

U - type of the transformation result

Parameters:

f - Transformation which creates a new object of type U based on this tuple's contents.

Returns:

An object of type U

Throws:

NullPointerException - if f is null

transform

@Deprecated
public <U> U transform(Function3<? super T1,? super T2,? super T3,? extends U> f)

Deprecated. Use apply(Function3) instead, will be removed in 3.0.0

Transforms this tuple to an object of type U.

Type Parameters:

U - type of the transformation result

Parameters:

f - Transformation which creates a new object of type U based on this tuple's contents.

Returns:

An object of type U

Throws:

NullPointerException - if f is null

toSeq

public Seq<?> toSeq()

Description copied from interface: Tuple

Converts this tuple to a sequence.

Specified by:

toSeq in interface Tuple

Returns:

A new Seq.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object