net.markenwerk.commons.datastructures

Class Pair<Payload>

java.lang.Object

net.markenwerk.commons.datastructures.Pair<Payload>

Type Parameters:

Payload - The payload type.

public final class Pair<Payload>
extends Object

A Pair is a simple immutable container class that holds two values of a similar type.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
Pair(Payload first, Payload second) Creates a new Pair.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Pair

public Pair(Payload first,
            Payload second)

Creates a new Pair.

Parameters:

first - The first value to be used.

second - The second second to be used.

Method Detail

getFirst

public Payload getFirst()

Returns the first value this Pair has been created with.

Returns:

The first value.

withFirst

public Pair<Payload> withFirst(Payload first)

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

Parameters:

first - The first value to be used.

Returns:

The created Pair.

getSecond

public Payload getSecond()

Returns the second value this Pair has been created with.

Returns:

The second value.

withSecond

public Pair<Payload> withSecond(Payload second)

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

Parameters:

second - The second value to be used.

Returns:

The created Pair.

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