io.vavr

Class Tuple1<T1>

java.lang.Object

io.vavr.Tuple1<T1>

Type Parameters:

T1 - type of the 1st element

All Implemented Interfaces:

Tuple, Serializable, Comparable<Tuple1<T1>>

public final class Tuple1<T1>
extends Object
implements Tuple, Comparable<Tuple1<T1>>, Serializable

A tuple of one element which can be seen as cartesian product of one component.

Author:

Daniel Dietrich

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
T1	_1 The 1st element of this tuple.

Fields inherited from interface io.vavr.Tuple

MAX_ARITY

Constructor Summary

Constructors

Constructor and Description
Tuple1(T1 t1) Constructs a tuple of one element.

Method Summary

Modifier and Type	Method and Description
T1	_1() Getter of the 1st element of this tuple.
<U> U	apply(Function<? super T1,? extends U> f) Transforms this tuple to an object of type U.
int	arity() Returns the number of elements of this tuple.
static <T1> Comparator<Tuple1<T1>>	comparator(Comparator<? super T1> t1Comp)
int	compareTo(Tuple1<T1> that)
boolean	equals(Object o)
int	hashCode()
<U1> Tuple1<U1>	map(Function<? super T1,? extends U1> mapper) Maps the components of this tuple using a mapper function.
Seq<?>	toSeq() Converts this tuple to a sequence.
String	toString()
Tuple1<T1>	update1(T1 value) Sets the 1st 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 io.vavr.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.

Constructor Detail

Tuple1

public Tuple1(T1 t1)

Constructs a tuple of one element.

Parameters:

t1 - the 1st element

Method Detail

comparator

public static <T1> Comparator<Tuple1<T1>> comparator(Comparator<? super T1> t1Comp)

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(Tuple1<T1> that)

Specified by:

compareTo in interface Comparable<Tuple1<T1>>

_1

public T1 _1()

Getter of the 1st element of this tuple.

Returns:

the 1st element of this Tuple.

update1

public Tuple1<T1> 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.

map

public <U1> Tuple1<U1> map(Function<? super T1,? extends U1> mapper)

Maps the components of this tuple using a mapper function.

Type Parameters:

U1 - new type of the 1st component

Parameters:

mapper - the mapper function

Returns:

A new Tuple of same arity.

Throws:

NullPointerException - if mapper is null

apply

public <U> U apply(Function<? super T1,? 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

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