org.perro.functions.mapper

Class DoubleObjectPair<T>

java.lang.Object

org.perro.functions.mapper.DoubleObjectPair<T>

public class DoubleObjectPair<T>
extends java.lang.Object

An immutable object that pairs a primitive double value, with an associated object of type <T>. Note that, unlike Pair, this class does not implement Map.Entry, because its left attribute is a primitive double.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
double	getLeft() Getter for the left double value associated with an object of type <T>.
T	getRight() Getter for the right object of type <T> associated with a double value.
int	hashCode() Generates a hash code based on the hash codes of its primitive double attribute, and its object of type <T>.
static <T> DoubleObjectPair<T>	of(double left, T right) Builds a new instance of this class, with the given double and <T> values.
java.lang.String	toString() Returns a string representation of the object, containing the primitive double left attribute and its associated object of type <T>.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <T> DoubleObjectPair<T> of(double left,
                                         T right)

Builds a new instance of this class, with the given double and <T> values.

Type Parameters:

T - The type of the right attribute for the resulting DoubleObjectPair instance.

Parameters:

left - A double value to be paired with an associated object of type <T>.

right - An object of type <T>.

Returns:

A new instance of this class.

getLeft

public double getLeft()

Getter for the left double value associated with an object of type <T>.

Returns:

A double value associated with an object of type <T>.

getRight

public T getRight()

Getter for the right object of type <T> associated with a double value.

Returns:

An object of type <T>.

hashCode

public int hashCode()

Generates a hash code based on the hash codes of its primitive double attribute, and its object of type <T>.

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code value for this object.

equals

public boolean equals(java.lang.Object obj)

Indicates whether some other object is "equal to" this one. The will be considered equal if the given object is of the same class, and is either the identical object, or the primitive double attribute and its object of type <T> are equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The target object with which to compare the current instance.

Returns:

true if this object is considered equal to the obj argument; false otherwise.

toString

public java.lang.String toString()

Returns a string representation of the object, containing the primitive double left attribute and its associated object of type <T>.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.