com.net2plan.utils

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

Object

com.net2plan.utils.Quintuple<A,B,C,D,E>

Type Parameters:

A - Class type for the first element

B - Class type for the second element

C - Class type for the third element

D - Class type for the fourth element

E - Class type for the fifth element

public class Quintuple<A,B,C,D,E>
extends Object

A tuple consisting of five elements. There is no restriction on the type of the objects that may be stored.

Example:

Map<String, Object> map = new LinkedHashMap<>();
map.put("parameter", "value");
Integer number = new Integer(3);
String string = "Test";
List list = new ArrayList();
Set set = new LinkedHashSet();

Quintuple<Map<String, Object>, Integer, String, List, Set> data = new Quintuple<>(map, number, string, list, set);

...

Map<String, Object> myMap = data.getFirst();
Integer myNumber = data.getSecond();
String myString = data.getThird();
List myList = data.getFourth();
Set mySet = data.getFifth();

Since:

0.3.0

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

See Also:

Pair, Triple, Quadruple

Constructor Summary

Constructors

Constructor and Description
Quintuple(A a, B b, C c, D d, E e, boolean isModifiable) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
E	getFifth() Returns the fifth element from this tuple.
A	getFirst() Returns the first element from this quintuple.
D	getFourth() Returns the fourth element from this quintuple.
B	getSecond() Returns the second element from this quintuple.
C	getThird() Returns the third element from this quintuple.
int	hashCode() Returns a hash code value for the object.
boolean	isModifiable() Indicates whether or not elements from the pair can be changed after initialization.
static <A,B,C,D,E> Quintuple<A,B,C,D,E>	of(A a, B b, C c, D d, E e) This factory allows a quintuple to be created using inference to obtain the generic types.
void	setFifth(E e) Sets the fifth element from this quintuple.
void	setFirst(A a) Sets the first element from this quintuple.
void	setFourth(D d) Sets the fourth element from this quintuple.
void	setSecond(B b) Sets the second element from this quintuple.
void	setThird(C c) Sets the third element from this quintuple.
String	toString() Returns a String representation of this quintuple using the format (first, second, third, fourth, fifth).
static <A,B,C,D,E> Quintuple<A,B,C,D,E>	unmodifiableOf(A a, B b, C c, D d, E e) This factory allows an unmodifiable quintuple to be created using inference to obtain the generic types.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Quintuple

public Quintuple(A a,
         B b,
         C c,
         D d,
         E e,
         boolean isModifiable)

Default constructor.

Parameters:

a - The first element, may be null

b - The second element, may be null

c - The third element, may be null

d - The fourth element, may be null

e - The fifth element, may be null

isModifiable - Indicates whether or not the elements can be changed after initialization

Since:

0.3.0

Method Detail

equals

public boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

o - Reference object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise

Since:

0.3.0

getFifth

public E getFifth()

Returns the fifth element from this tuple.

Returns:

The fifth element from this tuple

Since:

0.3.0

getFirst

public A getFirst()

Returns the first element from this quintuple.

Returns:

The first element from this quintuple

Since:

0.3.0

getFourth

public D getFourth()

Returns the fourth element from this quintuple.

Returns:

The fourth element from this quintuple

Since:

0.3.0

getSecond

public B getSecond()

Returns the second element from this quintuple.

Returns:

The second element from this quintuple

Since:

0.3.0

getThird

public C getThird()

Returns the third element from this quintuple.

Returns:

The third element from this quintuple

Since:

0.3.0

hashCode

public int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

Overrides:

hashCode in class Object

Returns:

Hash code value for this object

Since:

0.3.0

isModifiable

public boolean isModifiable()

Indicates whether or not elements from the pair can be changed after initialization.

Returns:

true if the element can be changed. Otherwise, false

Since:

0.3.0

of

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

This factory allows a quintuple to be created using inference to obtain the generic types.

Type Parameters:

A - Class type for the first element

B - Class type for the second element

C - Class type for the third element

D - Class type for the fourth element

E - Class type for the fifth element

Parameters:

a - The first element, may be null

b - The second element, may be null

c - The third element, may be null

d - The fourth element, may be null

e - The fifth element, may be null

Returns:

A quintuple formed from five parameters

Since:

0.3.0

setFifth

public void setFifth(E e)

Sets the fifth element from this quintuple.

Parameters:

e - The fifth element, may be null

Since:

0.3.0

setFirst

public void setFirst(A a)

Sets the first element from this quintuple.

Parameters:

a - The first element, may be null

Since:

0.3.0

setFourth

public void setFourth(D d)

Sets the fourth element from this quintuple.

Parameters:

d - The fourth element, may be null

Since:

0.3.0

setSecond

public void setSecond(B b)

Sets the second element from this quintuple.

Parameters:

b - The second element, may be null

Since:

0.3.0

setThird

public void setThird(C c)

Sets the third element from this quintuple.

Parameters:

c - The third element, may be null

Since:

0.3.0

toString

public String toString()

Returns a String representation of this quintuple using the format (first, second, third, fourth, fifth).

Overrides:

toString in class Object

Returns:

A String representation of this quintuple

Since:

0.3.0

unmodifiableOf

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

This factory allows an unmodifiable quintuple to be created using inference to obtain the generic types.

Type Parameters:

A - Class type for the first element

B - Class type for the second element

C - Class type for the third element

D - Class type for the fourth element

E - Class type for the fifth element

Parameters:

a - The first element, may be null

b - The second element, may be null

c - The third element, may be null

d - The fourth element, may be null

e - The fifth element, may be null

Returns:

A quintuple formed from five parameters

Since:

0.3.0