All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class tadt.standard.Interval

java.lang.Object
   |
   +----tadt.standard.Interval

public class Interval

extends Object

implements Unanchorable

Interval(Granularity, BigInteger)

Construct an Interval from a count of granules, known to be an BigInteger.

Interval(Granularity, TimeValue)

Construct an Interval from a TimeValue.

add(Interval)

Add this Interval to another.

asIntervalArray()

Retrieve the array of Intervals (containing only one Interval) from this interval.

asTimeValue()

Retrieve the TimeValue from this Interval

cast(Granularity)

Cast this Interval to the indicated granularity.

divide(Interval)

Divide this Interval by an Interval.

divide(TimeValue)

Divide an Interval by a constant.

enumerateIntervals()

Create an Enumeration on the Interval.

equals(Interval)

Test for equality, needed only for supporting Hashtables, use equalTo for comparing Intervals directly.

equals(Unanchorable)

Test for equality, needed only for supporting Hashtables, use equalTo for comparing Intervals directly.

equalTo(Interval)

Is this Interval the same as another?

granularity()

Retrieve the Granularity from this Interval

greaterThan(Interval)

Is this Interval bigger than another?

greaterThanOrEqualTo(Interval)

Is this Interval bigger than or the same as another?

hashCode()

Generate the hash code value, needed for supporting Hashtables.

image()

Build a nice string image of an Interval, for debugging mostly

kind()

Return the name of this class.

largest()

Get the largest (only!) Interval in this Interval.

lessThan(Interval)

Is this Interval smaller than another?

lessThanOrEqualTo(Interval)

Is this Interval smaller than or the same as another?

multiply(TimeValue)

Multiply an Interval by a constant.

negate()

Negate this Interval and return it.

newInstance(Interval[])

Construct a new Instance of an Interval

scale(Granularity)

Scale this Interval to the indicated granularity.

smallest()

Get the smallest (only!) Interval in this Interval.

subtract(Interval)

Subtract another Interval from this one.

  public Interval(Granularity g,
                  BigInteger granules)

Construct an Interval from a count of granules, known to be an BigInteger.

Parameters:

g - - granularity

granules - - distance in granules

  public Interval(Granularity g,
                  TimeValue tv)

Construct an Interval from a TimeValue.

  public String image()

Build a nice string image of an Interval, for debugging mostly

Returns:

String image of Interval

  public int hashCode()

Generate the hash code value, needed for supporting Hashtables.

Returns:

int

Overrides:

hashCode in class Object

  public boolean equals(Unanchorable other)

Test for equality, needed only for supporting Hashtables, use equalTo for comparing Intervals directly.

Parameters:

other - - Interval to compare

Returns:

true or false

  public boolean equals(Interval other)

Test for equality, needed only for supporting Hashtables, use equalTo for comparing Intervals directly.

Parameters:

other - - Interval to compare

Returns:

true or false

  public Interval negate()

Negate this Interval and return it.

Returns:

-this

  public Interval add(Interval i)

Add this Interval to another.

Parameters:

i - Interval to be added

Returns:

this + i

  public Interval multiply(TimeValue n)

Multiply an Interval by a constant.

Parameters:

n - TimeValue to multiply

Returns:

this * n

  public TimeValue divide(Interval i)

Divide this Interval by an Interval.

Parameters:

i - Interval to divide by

Returns:

this / i

Throws: divideByZero

(division by zero length interval)

  public Interval divide(TimeValue n)

Divide an Interval by a constant.

Parameters:

n - - TimeValue to divide by

Returns:

this / n

Throws: divideByZero

(division by zero)

  public Interval subtract(Interval i)

Subtract another Interval from this one.

Parameters:

i - Interval to be subtracted

Returns:

this - i

  public Enumeration enumerateIntervals()

Create an Enumeration on the Interval.

  public Interval cast(Granularity g)

Cast this Interval to the indicated granularity. Note that it is not a mutator, it will create a new Anchorable. Implemented as identity function.

  public Interval scale(Granularity g)

Scale this Interval to the indicated granularity. Note that it is not a mutator, it will create a new Interval. Implemented as identity function.

  public Interval smallest()

Get the smallest (only!) Interval in this Interval.

Returns:

this

  public Interval largest()

Get the largest (only!) Interval in this Interval.

Returns:

this

  public ExtendedBoolean lessThan(Interval beta)

Is this Interval smaller than another?

Parameters:

beta - - Interval to compare

Returns:

this < beta

  public ExtendedBoolean greaterThan(Interval beta)

Is this Interval bigger than another?

Parameters:

beta - - Interval to compare

Returns:

this > beta

  public ExtendedBoolean equalTo(Interval beta)

Is this Interval the same as another?

Parameters:

beta - - Interval to compare

Returns:

this == beta

  public ExtendedBoolean lessThanOrEqualTo(Interval beta)

Is this Interval smaller than or the same as another?

Parameters:

beta - - Interval to compare

Returns:

this <= beta

  public ExtendedBoolean greaterThanOrEqualTo(Interval beta)

Is this Interval bigger than or the same as another?

Parameters:

beta - - Interval to compare

Returns:

this >= beta

  public Interval[] asIntervalArray()

Retrieve the array of Intervals (containing only one Interval) from this interval.

Returns:

array of Intervals with one Interval in it.

  public Granularity granularity()

Retrieve the Granularity from this Interval

Returns:

Granularity

  public TimeValue asTimeValue()

Retrieve the TimeValue from this Interval

Returns:

TimeValue

  public Unanchorable newInstance(Interval i[])

Construct a new Instance of an Interval

Returns:

- new Unanchorable

  public String kind()

Return the name of this class.

Returns:

- new Unanchorable

All Packages  Class Hierarchy  This Package  Previous  Next  Index