org.perro.functions.mapper

Class IntObjectPair<T>

java.lang.Object

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

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

An immutable object that pairs a primitive int 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 int.

Method Summary

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

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

Type Parameters:

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

Parameters:

left - An int 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 int getLeft()

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

Returns:

An int value associated with an object of type <T>.

getRight

public T getRight()

Getter for the right object of type <T> associated with an int value.

Returns:

An object of type <T>.

hashCode

public int hashCode()

Generates a hash code based on the hash codes of its primitive int 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 int 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 int left attribute and its associated object of type <T>.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.