RegularSchedule (TreeSched API)
Keywords: org.treesched.RegularSchedule class

Overview | Package | Class | Tree | Deprecated | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.treesched
Class RegularSchedule

    java.lang.Object
      org.treesched.AbstractSchedule
          org.treesched.RegularSchedule

All Implemented Interfaces:
  RefineableSchedule, Schedule, java.io.Serializable

Direct Known Subclasses:
  DailySchedule, IntervalSchedule, MonthlySchedule, WeeklySchedule, YearlySchedule

public abstract class RegularSchedule
extends AbstractSchedule

This is a base class for schedule which repeat at intervals.

Author:
  Rob Gordon
See Also:
  Serialized Form

Constructor Summary
`RegularSchedule()`

Method Summary
`abstract java.util.Date` | `next(java.util.Date from)` Given a date, return the date which is interval of this RegularScheudle later.
`Interval` | `nextDue(java.util.Date now)` For a given date a schedule will provide the interval this schedule should next be scheduled in.
`java.lang.String` | `toString()` Override toString to be more meaningful.

Methods inherited from class org.treesched.AbstractSchedule
`addChildSchedule, getChildSchedule, getLimits, reset, setChildSchedule, setLimits`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### RegularSchedule

    public RegularSchedule()

Method Detail

### next

    public abstract java.util.Date next(java.util.Date from)

  Given a date, return the date which is interval of this RegularScheudle later.

  Parameters:
    `from` - The date from which this schedule runs.
  Returns:
    The interval later.

### nextDue

    public Interval nextDue(java.util.Date now)

  Description copied from interface: `Schedule`
  For a given date a schedule will provide the interval this schedule should next be scheduled in.

  If the schedule is never due again for the given date, null is returned.

  Parameters:
    `now` - The date now.
  Returns:
    The next due interval for the schedule.

### toString

    public java.lang.String toString()

  Override toString to be more meaningful.

  Returns:
    a Description of this schedule.

Overview | Package | Class | Tree | Deprecated | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD