org.apache.flink.api.java.tuple

Class Tuple2<T0,T1>

java.lang.Object

org.apache.flink.api.java.tuple.Tuple

org.apache.flink.api.java.tuple.Tuple2<T0,T1>

Type Parameters:

T0 - The type of field 0

T1 - The type of field 1

All Implemented Interfaces:

Serializable

public class Tuple2<T0,T1>
extends Tuple

A tuple with 2 fields. Tuples are strongly typed; each field may be of a separate type. The fields of the tuple can be accessed directly as public fields (f0, f1, ...) or via their position through the getField(int) method. The tuple field positions start at zero.

Tuples are mutable types, meaning that their fields can be re-assigned. This allows functions that work with Tuples to reuse objects in order to reduce pressure on the garbage collector.

See Also:

Tuple, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
T0	f0 Field 0 of the tuple.
T1	f1 Field 1 of the tuple.

Fields inherited from class org.apache.flink.api.java.tuple.Tuple

MAX_ARITY

Constructor Summary

Constructors

Constructor and Description
Tuple2() Creates a new tuple where all fields are null.
Tuple2(T0 value0, T1 value1) Creates a new tuple and assigns the given values to the tuple's fields.

Method Summary

Modifier and Type	Method and Description
Tuple2<T0,T1>	copy() Shallow tuple copy.
boolean	equals(Object o) Deep equality for tuples by calling equals() on the tuple members
int	getArity() Gets the number of field in the tuple (the tuple arity).
<T> T	getField(int pos) Gets the field at the specified position.
int	hashCode()
static <T0,T1> Tuple2<T0,T1>	of(T0 value0, T1 value1) Creates a new tuple and assigns the given values to the tuple's fields.
<T> void	setField(T value, int pos) Sets the field at the specified position.
void	setFields(T0 value0, T1 value1) Sets new values to all fields of the tuple.
Tuple2<T1,T0>	swap() Returns a shallow copy of the tuple with swapped values.
String	toString() Creates a string representation of the tuple in the form (f0, f1), where the individual fields are the value returned by calling Object.toString() on that field.

Methods inherited from class org.apache.flink.api.java.tuple.Tuple

getFieldNotNull, getTupleClass

Methods inherited from class java.lang.Object

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

Field Detail

f0

public T0 f0

Field 0 of the tuple.

f1

public T1 f1

Field 1 of the tuple.

Constructor Detail

Tuple2

public Tuple2()

Creates a new tuple where all fields are null.

Tuple2

public Tuple2(T0 value0,
              T1 value1)

Creates a new tuple and assigns the given values to the tuple's fields.

Parameters:

value0 - The value for field 0

value1 - The value for field 1

Method Detail

getArity

public int getArity()

Description copied from class: Tuple

Gets the number of field in the tuple (the tuple arity).

Specified by:

getArity in class Tuple

Returns:

The number of fields in the tuple.

getField

public <T> T getField(int pos)

Description copied from class: Tuple

Gets the field at the specified position.

Specified by:

getField in class Tuple

Parameters:

pos - The position of the field, zero indexed.

Returns:

The field at the specified position.

setField

public <T> void setField(T value,
                         int pos)

Description copied from class: Tuple

Sets the field at the specified position.

Specified by:

setField in class Tuple

Parameters:

value - The value to be assigned to the field at the specified position.

pos - The position of the field, zero indexed.

setFields

public void setFields(T0 value0,
                      T1 value1)

Sets new values to all fields of the tuple.

Parameters:

value0 - The value for field 0

value1 - The value for field 1

swap

public Tuple2<T1,T0> swap()

Returns a shallow copy of the tuple with swapped values.

Returns:

shallow copy of the tuple with swapped values

toString

public String toString()

Creates a string representation of the tuple in the form (f0, f1), where the individual fields are the value returned by calling Object.toString() on that field.

Overrides:

toString in class Object

Returns:

The string representation of the tuple.

equals

public boolean equals(Object o)

Deep equality for tuples by calling equals() on the tuple members

Overrides:

equals in class Object

Parameters:

o - the object checked for equality

Returns:

true if this is equal to o.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

copy

public Tuple2<T0,T1> copy()

Shallow tuple copy.

Specified by:

copy in class Tuple

Returns:

A new Tuple with the same fields as this.

of

public static <T0,T1> Tuple2<T0,T1> of(T0 value0,
                                       T1 value1)

Creates a new tuple and assigns the given values to the tuple's fields. This is more convenient than using the constructor, because the compiler can infer the generic type arguments implicitly. For example: Tuple3.of(n, x, s) instead of new Tuple3<Integer, Double, String>(n, x, s)