org.oddjob.schedules

Class SimpleScheduleResult

java.lang.Object

org.oddjob.schedules.SimpleScheduleResult

All Implemented Interfaces:

java.io.Serializable, Interval, ScheduleResult

public class SimpleScheduleResult
extends java.lang.Object
implements ScheduleResult, java.io.Serializable

A simple ScheduleResult

See Also:

Serialized Form

Author:

rob

Field Summary

Fields inherited from interface org.oddjob.schedules.Interval

END_OF_TIME, START_OF_TIME

Constructor Summary

Constructors

Constructor and Description
SimpleScheduleResult(Interval interval)
SimpleScheduleResult(Interval interval, java.util.Date useNext)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other) Test if two intervals are equivalent.
java.util.Date	getFromDate() The date the interval is from which includes this date.
java.util.Date	getToDate() The date the interval is up to but excluding.
java.util.Date	getUseNext() For recurring schedules this property provide the date that should be used for the next call to Schedule.nextDue(ScheduleContext) by using the ScheduleContext.move(Date) method.
int	hashCode() Crude implementation of hashCode, so intervals could be stored in HashSets.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleScheduleResult

public SimpleScheduleResult(Interval interval)

SimpleScheduleResult

public SimpleScheduleResult(Interval interval,
                            java.util.Date useNext)

Method Detail

getFromDate

public java.util.Date getFromDate()

Description copied from interface: Interval

The date the interval is from which includes this date.

Specified by:

getFromDate in interface Interval

Returns:

A date. Never null and always less than or equal to the to date.

getToDate

public java.util.Date getToDate()

Description copied from interface: Interval

The date the interval is up to but excluding.

Specified by:

getToDate in interface Interval

Returns:

A date. Never null and always greater than or equal to the from date.

getUseNext

public java.util.Date getUseNext()

Description copied from interface: ScheduleResult

For recurring schedules this property provide the date that should be used for the next call to Schedule.nextDue(ScheduleContext) by using the ScheduleContext.move(Date) method. For most schedules this date will be identical to the Interval.getToDate() but for some schedules such AfterSchedule this will not be the case.

Specified by:

getUseNext in interface ScheduleResult

Returns:

A date. May be null to indicate there is no other next due for this schedule..

hashCode

public int hashCode()

Crude implementation of hashCode, so intervals could be stored in HashSets.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Test if two intervals are equivalent.

Intervals are equivalent if there start and end times are the same.

Overrides:

equals in class java.lang.Object

Parameters:

other - The interval to test against.

Returns:

true if they are equal.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object