Progeneric.Ptl.Types

Class Pair<TFirst,TSecond>

java.lang.Object

Progeneric.Ptl.Types.Pair<TFirst,TSecond>

Type Parameters:

TFirst - The type of the first element in the pair.

TSecond - The type of the second element in the pair.

All Implemented Interfaces:

IEquatable<Pair<TFirst,TSecond>>

public class Pair<TFirst,TSecond>
extends java.lang.Object
implements IEquatable<Pair<TFirst,TSecond>>

Holds two objects that can be treated as a single object.

Constructor Summary

Constructors

Constructor and Description
Pair(Pair<TFirst,TSecond> pair) Constructs a new instance of the Pair class from another Pair object.
Pair(TFirst first, TSecond second) Initializes a new instance of the Pair class containing the specified objects.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Tests whether this instance is equal to a specified object.
boolean	Equals(Pair<TFirst,TSecond> other) Tests whether this instance is equal to a specified pair.
TFirst	First() Gets the first object of the pair.
IStreamable<Pair<TFirst,TSecond>>	GetStreamAdaptor() Returns an instance that implements the IStreamable<Pair> interface.
int	hashCode() Returns the hash code for this instance.
TSecond	Second() Gets the second object of the pair.
void	SetFirst(TFirst value) Sets the first object of the pair.
void	SetSecond(TSecond value) Sets the second object of the pair.
java.lang.String	toString() Converts the value of this instance to its equivalent string representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pair

public Pair(TFirst first,
    TSecond second)

Initializes a new instance of the Pair class containing the specified objects.

Parameters:

first - The first object initializing the first element of the pair.

second - The second object initializing the second element of the pair.

Pair

public Pair(Pair<TFirst,TSecond> pair)

Constructs a new instance of the Pair class from another Pair object.

Parameters:

pair - The pair to copy.

Method Detail

First

public TFirst First()

Gets the first object of the pair.

Returns:

The first object of the pair.

SetFirst

public void SetFirst(TFirst value)

Sets the first object of the pair.

Parameters:

value - The first value to be set.

Second

public TSecond Second()

Gets the second object of the pair.

Returns:

The second object of the pair.

SetSecond

public void SetSecond(TSecond value)

Sets the second object of the pair.

Parameters:

value - The second value to be set.

equals

public boolean equals(java.lang.Object obj)

Tests whether this instance is equal to a specified object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - An object to compare with this instance.

Returns:

True if obj is an instance of Pair and equals the value of this instance; otherwise, false.

hashCode

public int hashCode()

Returns the hash code for this instance.

Overrides:

hashCode in class java.lang.Object

Returns:

A 32-bit signed integer hash code.

Equals

public boolean Equals(Pair<TFirst,TSecond> other)

Tests whether this instance is equal to a specified pair.

Specified by:

Equals in interface IEquatable<Pair<TFirst,TSecond>>

Parameters:

other - A pair to compare with this instance.

Returns:

True if the specified pair equals the value of this instance; otherwise, false.

toString

public java.lang.String toString()

Converts the value of this instance to its equivalent string representation.

Overrides:

toString in class java.lang.Object

Returns:

A string object representing the value of this instance.

GetStreamAdaptor

public IStreamable<Pair<TFirst,TSecond>> GetStreamAdaptor()

Returns an instance that implements the IStreamable<Pair> interface.

Returns:

An instance that implements the IStreamable<Pair> interface.