Package org.planit.utils.misc

Class Pair<A,B>

java.lang.Object

org.planit.utils.misc.Pair<A,B>

Type Parameters:

A - first object in pair

B - second object in pair

public class Pair<A,B>
extends Object

Custom pair class similar to C++. By default we compare based on the first value

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
protected A	first	The first object in this Pair
protected B	second	The second object in this Pair

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Pair(A first, B second)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	anyIsNotNull()	check if any of the two values is not null
boolean	bothNotNull()	check if both values are not null
static <A,B> Pair<A,B>	create(A valueA, B valueB)	Factory method
boolean	equals(Object other)	Compare to another pair
A	first()	Get first object in pair
Object	getEarliestNonNull()
int	hashCode()
boolean	isExactlyOneNonNull()
B	second()	Get second object in pair
String	toString()	Convert to string

Methods inherited from class java.lang.Object

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

Field Detail

first

protected final A first

The first object in this Pair

second

protected final B second

The second object in this Pair

Constructor Detail

Pair

protected Pair(A first,
               B second)

Constructor

Parameters:

first - first object in pair

second - second object in pair

Method Detail

create

public static <A,B> Pair<A,B> create(A valueA,
                                                 B valueB)

Factory method

Type Parameters:

A - type of valueA

B - type of valueB

Parameters:

valueA - first

valueB - second

Returns:

new pair

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

hashCode for this entity

See Also:

Object.hashCode()

equals

public boolean equals(Object other)

Compare to another pair

Overrides:

equals in class Object

Parameters:

other - pair being compared to

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Convert to string

Overrides:

toString in class Object

See Also:

Object.toString()

first

public A first()

Get first object in pair

Returns:

first object in pair

second

public B second()

Get second object in pair

Returns:

second object in pair

anyIsNotNull

public boolean anyIsNotNull()

check if any of the two values is not null

Returns:

true when one of the entries is not null

bothNotNull

public boolean bothNotNull()

check if both values are not null

Returns:

true when both entries are not null

isExactlyOneNonNull

public boolean isExactlyOneNonNull()

Returns:

true when exactly one of the two is not null

getEarliestNonNull

public Object getEarliestNonNull()

Returns:

earliest entry (first before second) that is nonNull, when both are null, null is returned