info.javelot.functionalj.tuple
Class Pair

java.lang.Object
  info.javelot.functionalj.tuple.Pair

All Implemented Interfaces:

Comparable, Serializable

Direct Known Subclasses:

Triple

public class Pair

extends Object

implements Comparable, Serializable

Used to create a tuple of two objects. Tuples can be used anywhere there is a need to group objects together, and Pairs are used by the Tuples.zip(Collection, Collection) method.

Author:

Copyright © 2006 Frederic Daoud

See Also:

Serialized Form

Field Summary

static Function1	first Function that returns the first element of the tuple.
static Function2	pair Function that creates a Pair.
static Function1	second Function that returns the second element of the tuple.

Constructor Summary

Pair(Object p_first, Object p_second)
Creates a tuple containing the two given objects.

Method Summary

int	compareTo(Object p_object) Sort tuples according to the objects that they contain.
boolean	equals(Object p_object) Determines if the given object is equal to this object, by comparing the two objects of each tuple using their respective equals(Object) methods.
Object	getFirst() Returns the first object of the tuple.
Object	getSecond() Returns the second object of the tuple.
protected List	getStrings() Returns a list of the String representations of the objects of the tuple.
int	hashCode() Returns the hash code associated with this object.
void	setFirst(Object p_first) Sets the first object of the tuple.
void	setSecond(Object p_second) Sets the second object of the tuple.
String	toString() Returns a String representation of the Pair.

Methods inherited from class java.lang.Object

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

Field Detail

pair

public static final Function2 pair

Function that creates a Pair.

first

public static final Function1 first

Function that returns the first element of the tuple.

second

public static final Function1 second

Function that returns the second element of the tuple.

Constructor Detail

Pair

public Pair(Object p_first,
            Object p_second)

Creates a tuple containing the two given objects.

Parameters:

p_first - the first object of the pair. A null value is accepted.

p_second - the second object of the pair. A null value is accepted.

Method Detail

getFirst

public Object getFirst()

Returns the first object of the tuple.

Returns:

the first object of the tuple, which may be null.

setFirst

public void setFirst(Object p_first)

Sets the first object of the tuple.

Parameters:

p_first - the first object of the tuple.

getSecond

public Object getSecond()

Returns the second object of the tuple.

Returns:

the second object of the tuple, which may be null.

setSecond

public void setSecond(Object p_second)

Sets the second object of the tuple.

Parameters:

p_second - the second object of the tuple.

hashCode

public int hashCode()

Returns the hash code associated with this object.

Thanks to Paul Field for suggesting the improvement on this hash function.

Returns:

the hash code associated with this object, which is calculated by adding together the hash codes of the objects contained in the tuple, multiplying by 31 each time. A null value is considered to have* a hash code of 0. Thus, if this pair contains two null values, this method returns 0.

equals

public boolean equals(Object p_object)

Determines if the given object is equal to this object, by comparing the two objects of each tuple using their respective equals(Object) methods. Corresponding null values are also considered equal.

Parameters:

p_object - the object against which to compare this tuple.

Returns:

true if the pairs contain the same values; false otherwise.

compareTo

public int compareTo(Object p_object)

Sort tuples according to the objects that they contain. If the contained in the tuples do not implement the Comparable interface, they are left unsorted.

Specified by:

compareTo in interface Comparable

getStrings

protected List getStrings()

Returns a list of the String representations of the objects of the tuple. Subclasses override this method to specify additional objects. The toString() method uses this to construct the String representation of the tuple.

Returns:

a list of the String representations of the objects of the tuple.

toString

public String toString()

Returns a String representation of the Pair.

Returns:

a String representation of the Pair of the form "(String, String)".