org.organicdesign.fp.tuple

Class Tuple5<A,B,C,D,E>

java.lang.Object

org.organicdesign.fp.tuple.Tuple5<A,B,C,D,E>

All Implemented Interfaces:

Serializable

public class Tuple5<A,B,C,D,E>
extends Object
implements Serializable

Holds 5 items of potentially different types. Designed to let you easily create immutable subclasses (to give your data structures meaningful names) with correct equals(), hashCode(), and toString() methods.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected A	_1
protected B	_2
protected C	_3
protected D	_4
protected E	_5

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Tuple5(A a, B b, C c, D d, E e) Constructor is protected (not public) for easy inheritance.

Method Summary

Modifier and Type	Method and Description
A	_1() Returns the 1st field
B	_2() Returns the 2nd field
C	_3() Returns the 3rd field
D	_4() Returns the 4th field
E	_5() Returns the 5th field
boolean	equals(Object other)
int	hashCode()
static <A,B,C,D,E> Tuple5<A,B,C,D,E>	of(A a, B b, C c, D d, E e) Public static factory method
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

_1

protected final A _1

_2

protected final B _2

_3

protected final C _3

_4

protected final D _4

_5

protected final E _5

Constructor Detail

Tuple5

protected Tuple5(A a,
                 B b,
                 C c,
                 D d,
                 E e)

Constructor is protected (not public) for easy inheritance. Josh Bloch's "Item 1" says public static factory methods are better than constructors because they have names, they can return an existing object instead of a new one, and they can return a sub-type. Therefore, you have more flexibility with a static factory as part of your public API then with a public constructor.

Method Detail

of

public static <A,B,C,D,E> Tuple5<A,B,C,D,E> of(A a,
                                               B b,
                                               C c,
                                               D d,
                                               E e)

Public static factory method

_1

public A _1()

Returns the 1st field

_2

public B _2()

Returns the 2nd field

_3

public C _3()

Returns the 3rd field

_4

public D _4()

Returns the 4th field

_5

public E _5()

Returns the 5th field

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object