beagleutil

Class BasicIntInterval

java.lang.Object

beagleutil.BasicIntInterval

All Implemented Interfaces:

IntInterval, java.lang.Comparable<BasicIntInterval>

public final class BasicIntInterval
extends java.lang.Object
implements IntInterval, java.lang.Comparable<BasicIntInterval>

Class BasicIntInterval represents an interval of consecutive integers.

Instances of class BasicIntInterval are immutable.

Constructor Summary

Constructors

Constructor and Description
BasicIntInterval(int start, int end) Constructs an SimpleIntInterval instance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(BasicIntInterval o) Compares the specified BasicIntInterval with this for order, and returns a negative integer, zero, or a positive integer as this is less than, equal to, or greater than the specified BasicIntInterval object.
int	end() Returns the end of the interval (inclusive).
boolean	equals(java.lang.Object obj) Returns true if the specified object is an BasicIntInterval instance and this.start() == ((BasicIntInterval) obj).start(), and this.end() == ((BasicIntInterval) obj).end(), and returns false otherwise.
int	hashCode() Returns a hash code value for the object.
int	start() Returns the start of the interval (inclusive).
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

BasicIntInterval

public BasicIntInterval(int start,
                        int end)

Constructs an SimpleIntInterval instance.

Parameters:

start - the starting integer (inclusive).

end - the ending integer (inclusive).

Throws:

java.lang.IllegalArgumentException - if start>end.

Method Detail

start

public int start()

Description copied from interface: IntInterval

Returns the start of the interval (inclusive).

Specified by:

start in interface IntInterval

Returns:

the start of the interval (inclusive).

end

public int end()

Description copied from interface: IntInterval

Returns the end of the interval (inclusive).

Specified by:

end in interface IntInterval

Returns:

the end of the interval (inclusive).

hashCode

public int hashCode()

Returns a hash code value for the object.

The hash code is defined by the following calculation:

        int hash = 3;
        hash += 59 * hash + this.start();
        hash += 59 * hash + this.end();
 

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for the object.

equals

public boolean equals(java.lang.Object obj)

Returns true if the specified object is an BasicIntInterval instance and this.start() == ((BasicIntInterval) obj).start(), and this.end() == ((BasicIntInterval) obj).end(), and returns false otherwise.

Overrides:

equals in class java.lang.Object

Parameters:

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

Returns:

true if the specified object is equal to this, and returns false otherwise.

compareTo

public int compareTo(BasicIntInterval o)

Compares the specified BasicIntInterval with this for order, and returns a negative integer, zero, or a positive integer as this is less than, equal to, or greater than the specified BasicIntInterval object. BasicIntInterval objects are ordered by their start and their end values in that order.

Specified by:

compareTo in interface java.lang.Comparable<BasicIntInterval>

Parameters:

o - the BasicIntInterval to be compared with this.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

toString

public java.lang.String toString()

Returns a string representation of this. The exact details of the representation are unspecified and subject to change.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this. The exact details of the representation are unspecified and subject to change.