org.nerd4j.utils.tuple

Class Triple<L,M,R>

java.lang.Object

org.nerd4j.utils.tuple.Triple<L,M,R>

Type Parameters:

L - type of the left element.

M - type of the middle element.

R - type of the right element.

All Implemented Interfaces:

Serializable, Emptily

Direct Known Subclasses:

ComparableTriple

public class Triple<L,M,R>
extends Object
implements Serializable, Emptily

Represents an immutable triple of values.

The values of the triple can be mutable but the association, created by this class, among three instances cannot change.

The values of the triple are addressed as: left, middle and right.

This implementation does't make any assumption on the nature of the values. There is an extension of Triple that requires the provided values to be Comparable and therefore is able to implement the Comparable interface for itself.

This class implements Emptily. A triple is considered to be empty if all of its values are null.

Since:

2.0.0

Author:

Massimo Coluzzi

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected L	left The left element of the triple.
protected M	middle The middle element of the triple.
protected R	right The right element of the triple.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Triple() Default constructor.
protected	Triple(L left, M middle, R right) Constructor with parameters.

Method Summary

Modifier and Type	Method and Description
static <L,M,R> Triple<L,M,R>	empty() Returns the singleton instance of an empty Triple.
boolean	equals(Object other)
L	getLeft() Returns the left element of the triple.
M	getMiddle() Returns the middle element of the triple.
R	getRight() Returns the right element of the triple.
int	hashCode()
boolean	isEmpty() Returns true if this object is empty.
static <L,M,R> Triple<L,M,R>	of(L left, M middle, R right) Creates a new Triple with the given values.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

left

protected final L left

The left element of the triple.

middle

protected final M middle

The middle element of the triple.

right

protected final R right

The right element of the triple.

Constructor Detail

Triple

protected Triple()

Default constructor.

This constructor is intended to be used by reflection during deserialization.

To create a new triple use the factory method.

Triple

protected Triple(L left,
                 M middle,
                 R right)

Constructor with parameters.

This constructor is intended to be used by extending classes only.

To create a new triple use the factory methods.

Parameters:

left - the left element of the triple.

middle - the middle element of the triple.

right - thr right element of the triple.

Method Detail

empty

public static <L,M,R> Triple<L,M,R> empty()

Returns the singleton instance of an empty Triple.

Type Parameters:

L - type of the left element.

M - type of the middle element.

R - type of the right element.

Returns:

singleton instance of an empty Triple.

of

public static <L,M,R> Triple<L,M,R> of(L left,
                                       M middle,
                                       R right)

Creates a new Triple with the given values.

Type Parameters:

L - type of the left element.

M - type of the middle element.

R - type of the right element.

Parameters:

left - the left element of the triple.

middle - the middle element of the triple.

right - thr right element of the triple.

Returns:

a new triple with the given values.

isEmpty

public boolean isEmpty()

Returns true if this object is empty.

Specified by:

isEmpty in interface Emptily

Returns:

true if this object is empty.

getLeft

public L getLeft()

Returns the left element of the triple.

Returns:

left element of the triple.

getMiddle

public M getMiddle()

Returns the middle element of the triple.

Returns:

middle element of the triple.

getRight

public R getRight()

Returns the right element of the triple.

Returns:

right element of the triple.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object