net.markenwerk.commons.datastructures

Class Tuple<First,Second>

java.lang.Object

net.markenwerk.commons.datastructures.Tuple<First,Second>

Type Parameters:

First - The type of the first value.

Second - The type of the second value.

public final class Tuple<First,Second>
extends Object

A Tuple is a simple immutable container class that holds two values.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
Tuple(First first, Second second) Creates a new Tuple.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
First	getFirst() Returns the first value this Tuple has been created with.
Second	getSecond() Returns the second value this Tuple has been created with.
int	hashCode()
String	toString()
Tuple<First,Second>	withFirst(First first) Creates a new Tuple with the given first value and the second value from this Tuple.
Tuple<First,Second>	withSecond(Second second) Creates a new Tuple with the given second value and the first value from this Tuple.

Methods inherited from class java.lang.Object

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

Constructor Detail

Tuple

public Tuple(First first,
             Second second)

Creates a new Tuple.

Parameters:

first - The first value to be used.

second - The second second to be used.

Method Detail

getFirst

public First getFirst()

Returns the first value this Tuple has been created with.

Returns:

The first value.

withFirst

public Tuple<First,Second> withFirst(First first)

Creates a new Tuple with the given first value and the second value from this Tuple.

Parameters:

first - The first value to be used.

Returns:

The created Tuple.

getSecond

public Second getSecond()

Returns the second value this Tuple has been created with.

Returns:

The second value.

withSecond

public Tuple<First,Second> withSecond(Second second)

Creates a new Tuple with the given second value and the first value from this Tuple.

Parameters:

second - The second value to be used.

Returns:

The created Tuple.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object