org.thegalactic.util

Class Couple

java.lang.Object

org.thegalactic.util.Couple

public class Couple
extends Object

This class provides a representation of couple (A,B) of objects.

Author:

jeff

Constructor Summary

Constructors

Constructor and Description
Couple(Object l, Object r) Constructor from two objects.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Couple c) Returns true if c is equals to this component.
Object	getLeft() Returns left hand side of this component.
Object	getRight() Returns right hand side of this component.
int	hashCode() Compute the hash code.
Couple	setLeft(Object left) Set left hand side of this component.
Couple	setRight(Object right) Set right hand side of this component.
String	toString() Returns a string representations of this component.

Methods inherited from class java.lang.Object

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

Constructor Detail

Couple

public Couple(Object l,
              Object r)

Constructor from two objects.

Parameters:

l - left hand side of this component

r - right hand side of this component

Method Detail

getLeft

public Object getLeft()

Returns left hand side of this component.

Returns:

left hand side of this component

setLeft

public Couple setLeft(Object left)

Set left hand side of this component.

Parameters:

left - hand side of this component

Returns:

this for chaining

getRight

public Object getRight()

Returns right hand side of this component.

Returns:

right hand side of this component

setRight

public Couple setRight(Object right)

Set right hand side of this component.

Parameters:

right - hand side of this component

Returns:

this for chaining

equals

public boolean equals(Couple c)

Returns true if c is equals to this component.

Parameters:

c - Couple tested with this component

Returns:

true if c is equals to this component.

hashCode

public int hashCode()

Compute the hash code.

Overrides:

hashCode in class Object

Returns:

an integer representing the object

toString

public String toString()

Returns a string representations of this component.

Overrides:

toString in class Object

Returns:

a string representations of this component.