com.microstrategy.usher

Class PairEntity<F,S>

java.lang.Object

com.microstrategy.usher.PairEntity<F,S>

public class PairEntity<F,S>
extends java.lang.Object

Container to ease passing around a tuple of two objects. This object provides a sensible implementation of equals(Object), returning true if Object.equals(Object) is true on each of the contained objects.

Field Summary

Fields

Modifier and Type	Field and Description
F	first First element in the tuple of type F
S	second Second element in the tuple of type S

Constructor Summary

Constructors

Constructor and Description
PairEntity(F first, S second) Constructor for a PairEntity.

Method Summary

Modifier and Type	Method and Description
static <A,B> PairEntity<A,B>	create(A a, B b) Returns an appropriately typed PairEntity.
boolean	equals(java.lang.Object o) Returns a boolean that represents whether or not two objects are equal by delegating to their respective Object.equals(Object) methods.
int	hashCode() Returns an int of the hash code using the hash codes of the underlying objects.
java.lang.String	toString() Returns a String of the value of the first object plus the value of the second object.

Methods inherited from class java.lang.Object

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

Field Detail

first

public final F first

First element in the tuple of type F

second

public final S second

Second element in the tuple of type S

Constructor Detail

PairEntity

public PairEntity(F first,
                  S second)

Constructor for a PairEntity.

Parameters:

first - the first object in the PairEntity

second - the second object in the PairEntity

Method Detail

create

public static <A,B> PairEntity<A,B> create(A a,
                                           B b)

Returns an appropriately typed PairEntity.

Type Parameters:

A - the type of the first object in the PairEntity

B - the type of the second object in the PairEntity

Parameters:

a - the first object in the PairEntity

b - the second object in the PairEntity

Returns:

a PairEntity that is templatized with the types of a and b

equals

public boolean equals(java.lang.Object o)

Returns a boolean that represents whether or not two objects are equal by delegating to their respective Object.equals(Object) methods.

Overrides:

equals in class java.lang.Object

Parameters:

o - the PairEntity to which this one is to be checked for equality

Returns:

true if the underlying objects of the Pair are both considered equal; false otherwise.

hashCode

public int hashCode()

Returns an int of the hash code using the hash codes of the underlying objects.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code of the PairEntity objects.

toString

public java.lang.String toString()

Returns a String of the value of the first object plus the value of the second object.

Overrides:

toString in class java.lang.Object

Returns:

the value of the first object plus the value of the second object.