org.perro.functions.mapper

Class ObjectIndexPair<T>

java.lang.Object

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

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

An immutable object that pairs an object of type <T>, with an associated int index. Note that, unlike Pair, this class does not implement Map.Entry, because it deals with a primitive index value.

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	getIndex() Getter for the index.
T	getObject() Getter for an object of type <T> associated with an index.
int	hashCode() Generates a hash code based on the hash codes of its attributes.
static <T> ObjectIndexPair<T>	of(T object, int index) Builds a new instance of this class, with the given object and index values.
java.lang.String	toString() Returns a string representation of the object, containing the object of type <T> and int index attributes of this object.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <T> ObjectIndexPair<T> of(T object,
                                        int index)

Builds a new instance of this class, with the given object and index values.

Type Parameters:

T - The type of the object to be paired with an int index.

Parameters:

object - An object of type <T> to be paired with an associated index.

index - An int index.

Returns:

A new instance of this class.

getObject

public T getObject()

Getter for an object of type <T> associated with an index.

Returns:

An object of type <T> associated with an index.

getIndex

public int getIndex()

Getter for the index.

Returns:

An index associated with an object of type <T>.

hashCode

public int hashCode()

Generates a hash code based on the hash codes of its attributes.

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 object of type <T> and int index attributes 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 object of type <T> and int index attributes of this object.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.