Home » quartz-1.6.0 » org » quartz » [javadoc | source]
public interface: Calendar [javadoc | source]

All Implemented Interfaces:

All Known Implementing Classes:
    WeeklyCalendar, DailyCalendar, CalendarBundle, AnnualCalendar, CronCalendar, MonthlyCalendar, BaseCalendar, HolidayCalendar

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)

Field Summary
 int MONTH     
Method from org.quartz.Calendar Summary:
getBaseCalendar,   getDescription,   getNextIncludedTime,   isTimeIncluded,   setBaseCalendar,   setDescription
Method from org.quartz.Calendar Detail:
 public Calendar getBaseCalendar()

    Get the base calendar. Will be null, if not set.

 public String getDescription()

    Return the description given to the Calendar instance by its creator (if any).

 public long getNextIncludedTime(long timeStamp)

    Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time.

 public boolean isTimeIncluded(long timeStamp)

    Determine whether the given time (in milliseconds) is 'included' by the Calendar.

 public  void setBaseCalendar(Calendar baseCalendar)

    Set a new base calendar or remove the existing one.

 public  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.