javafixes.object

Class Tuple<A,B>

java.lang.Object

javafixes.object.DataObject

javafixes.object.Tuple<A,B>

Type Parameters:

A - type of first value

B - type of second value

public class Tuple<A,B>
extends DataObject

Immutable holder of two values. Both values can have different type and can be null. It implements methods equals(), hashCode() and toString()

It's useful when if you would like to have a composite return value from a method or as a composite key to a map.

Since:

07/13/16 8:53 PM

Field Summary

Fields

Modifier and Type	Field and Description
A	a
B	b

Constructor Summary

Constructors

Constructor and Description
Tuple(A a, B b) Constructor of Tuple with two values to wrap

Method Summary

Modifier and Type	Method and Description
A	a() Returns first value
B	b() Returns second value
A	getA() Returns first value
B	getB() Returns second value
<C> C	map(java.util.function.BiFunction<? super A,? super B,? extends C> mapper) Maps wrapped values using a provided BiFunction
static <A,B> Tuple<A,B>	tuple(A a, B b) Factory method to create Tuple.

Methods inherited from class javafixes.object.DataObject

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

a

public final A a

b

public final B b

Constructor Detail

Tuple

public Tuple(A a,
             B b)

Constructor of Tuple with two values to wrap

Parameters:

a - first value

b - second value

Method Detail

tuple

public static <A,B> Tuple<A,B> tuple(A a,
                                     B b)

Factory method to create Tuple.

Type Parameters:

A - first value type

B - second value type

Parameters:

a - first value

b - second value

Returns:

new Tuple

getA

public A getA()

Returns first value

Returns:

first value

getB

public B getB()

Returns second value

Returns:

second value

a

public A a()

Returns first value

Returns:

first value

b

public B b()

Returns second value

Returns:

second value

map

public <C> C map(java.util.function.BiFunction<? super A,? super B,? extends C> mapper)

Maps wrapped values using a provided BiFunction

Type Parameters:

C - the type of generated value

Parameters:

mapper - function to map wrapped values

Returns:

value generated via the mapping function