blbutil

Class IntPair

java.lang.Object

blbutil.IntPair

All Implemented Interfaces:

java.lang.Comparable<IntPair>

public final class IntPair
extends java.lang.Object
implements java.lang.Comparable<IntPair>

Class IntPair represents an ordered pair of integers.

Instances of class IntPair are immutable.

Constructor Summary

Constructors

Constructor and Description
IntPair(int first, int second) Constructs an IntPair instance that represents the specified ordered pair of integers.

Method Summary

Modifier and Type	Method and Description
int	compareTo(IntPair other) Returns -1, 0, or 1 depending on whether this is less than, equal, or greater than the specified IntPair object.
boolean	equals(java.lang.Object obj) Compares the specified object with this IntPair for equality.
int	first() Returns the first integer in the ordered pair of integers.
int	hashCode() Returns a hash code value for the object.
int	second() Returns the second integer in the ordered pair of integers.
java.lang.String	toString() Returns a string representation of this.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntPair

public IntPair(int first,
               int second)

Constructs an IntPair instance that represents the specified ordered pair of integers.

Parameters:

first - the first element of the ordered pair of integers.

second - the second element of the ordered pair of integers.

Method Detail

first

public int first()

Returns the first integer in the ordered pair of integers.

Returns:

the first integer in the ordered pair of integers.

second

public int second()

Returns the second integer in the ordered pair of integers.

Returns:

the second integer in the ordered pair of integers.

equals

public boolean equals(java.lang.Object obj)

Compares the specified object with this IntPair for equality. Returns true if the specified object is an IntPair that represents the same ordered pair of integers as this, and returns false otherwise.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to be compared for equality with this IntPair.

Returns:

true if the specified object is an IntPair that represents the same ordered pair of integers as this, and returns false otherwise.

hashCode

public int hashCode()

Returns a hash code value for the object.

The hash code is defined by the following calculation:

        int hash = 5;
        hash = 29 * hash + this.first;
        hash = 29 * hash + this.second;
 

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for the object.

toString

public java.lang.String toString()

Returns a string representation of this. The string representation is "[i1, i2]" where i1 and i2 are the first and second integers in the ordered pair of integers represented by this.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this.

compareTo

public int compareTo(IntPair other)

Returns -1, 0, or 1 depending on whether this is less than, equal, or greater than the specified IntPair object. IntPair instances are ordered using lexicographical order.

Specified by:

compareTo in interface java.lang.Comparable<IntPair>

Parameters:

other - an IntPair instance to be compared to this.

Returns:

-1, 0, or 1 depending on whether this is less than, equal, or greater than the specified IntPair object.