com.net2plan.utils

Class Triple<A,B,C>

Object

com.net2plan.utils.Triple<A,B,C>

Type Parameters:

A - Class type for the first element

B - Class type for the second element

C - Class type for the third element

public class Triple<A,B,C>
extends Object

A tuple consisting of three 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";

Triple<Map<String, Object>, Integer, String> data = new Triple<>(map, number, string);

...

Map<String, Object> myMap = data.getFirst();
Integer myNumber = data.getSecond();
String myString = data.getThird();

Since:

0.2.0

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

See Also:

Pair, Quadruple, Quintuple

Constructor Summary

Constructors

Constructor and Description
Triple(A a, B b, C c, 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.
A	getFirst() Returns the first element from this triple.
B	getSecond() Returns the second element from this triple.
C	getThird() Returns the third element from this triple.
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> Triple<A,B,C>	of(A a, B b, C c) This factory allows a triple to be created using inference to obtain the generic types.
void	setFirst(A a) Sets the first element from this triple.
void	setSecond(B b) Sets the second element from this triple.
void	setThird(C c) Sets the third element from this triple.
String	toString() Returns a String representation of this triple using the format (first, second, third).
static <A,B,C> Triple<A,B,C>	unmodifiableOf(A a, B b, C c) This factory allows an unmodifiable triple to be created using inference to obtain the generic types.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Triple

public Triple(A a,
      B b,
      C c,
      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

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.2.0

getFirst

public A getFirst()

Returns the first element from this triple.

Returns:

The first element from this triple

Since:

0.2.0

getSecond

public B getSecond()

Returns the second element from this triple.

Returns:

The second element from this triple

Since:

0.2.0

getThird

public C getThird()

Returns the third element from this triple.

Returns:

The third element from this triple

Since:

0.2.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.2.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> Triple<A,B,C> of(A a,
                       B b,
                       C c)

This factory allows a triple 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

Parameters:

a - The first element, may be null

b - The second element, may be null

c - The third element, may be null

Returns:

A triple formed from three parameters

Since:

0.2.0

setFirst

public void setFirst(A a)

Sets the first element from this triple.

Parameters:

a - The first element, may be null

Since:

0.2.0

setSecond

public void setSecond(B b)

Sets the second element from this triple.

Parameters:

b - The second element, may be null

Since:

0.2.0

setThird

public void setThird(C c)

Sets the third element from this triple.

Parameters:

c - The third element, may be null

Since:

0.2.0

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A String representation of this triple

Since:

0.2.0

unmodifiableOf

public static <A,B,C> Triple<A,B,C> unmodifiableOf(A a,
                                   B b,
                                   C c)

This factory allows an unmodifiable triple 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

Parameters:

a - The first element, may be null

b - The second element, may be null

c - The third element, may be null

Returns:

An unmodifiable triple formed from three parameters

Since:

0.3.0