| org.quartz.Calendar
All known Subclasses: org.quartz.xml.CalendarBundle, org.quartz.impl.calendar.BaseCalendar, org.quartz.impl.calendar.HolidayCalendar, org.quartz.impl.calendar.WeeklyCalendar, org.quartz.impl.calendar.AnnualCalendar, org.quartz.impl.calendar.MonthlyCalendar,
Calendar | public interface Calendar extends java.io.Serializable(Code) | |
An interface to be implemented by objects that define spaces of time during
which an associated
Trigger may fire. Calendars do not
define actual fire times, but rather are used to limit a Trigger
from firing on its normal schedule if necessary. Most Calendars include all
times by default and allow the user to specify times to exclude. As such, it
is often useful to think of Calendars as being used to exclude a block
of time — as opposed to include a block of time. (i.e. the
schedule "fire every five minutes except on Sundays" could be
implemented with a SimpleTrigger and a
WeeklyCalendar which excludes Sundays)
author: James House author: Juergen Donnerstag |
Method Summary | |
Calendar | getBaseCalendar()
Get the base calendar. | String | getDescription()
Return the description given to the Calendar instance by
its creator (if any). | long | getNextIncludedTime(long timeStamp)
Determine the next time (in milliseconds) that is 'included' by the
Calendar after the given time. | boolean | isTimeIncluded(long timeStamp)
Determine whether the given time (in milliseconds) is 'included' by the
Calendar. | void | setBaseCalendar(Calendar baseCalendar)
Set a new base calendar or remove the existing one. | void | setDescription(String description)
Set a description for the Calendar instance - may be
useful for remembering/displaying the purpose of the calendar, though
the description has no meaning to Quartz. |
getBaseCalendar | Calendar getBaseCalendar()(Code) | |
Get the base calendar. Will be null, if not set.
|
getDescription | String getDescription()(Code) | |
Return the description given to the Calendar instance by
its creator (if any).
null if no description was set. |
getNextIncludedTime | long getNextIncludedTime(long timeStamp)(Code) | |
Determine the next time (in milliseconds) that is 'included' by the
Calendar after the given time.
|
isTimeIncluded | boolean isTimeIncluded(long timeStamp)(Code) | |
Determine whether the given time (in milliseconds) is 'included' by the
Calendar.
|
setBaseCalendar | void setBaseCalendar(Calendar baseCalendar)(Code) | |
Set a new base calendar or remove the existing one.
|
setDescription | void setDescription(String description)(Code) | |
Set a description for the Calendar instance - may be
useful for remembering/displaying the purpose of the calendar, though
the description has no meaning to Quartz.
|
|
|