|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.quartz.impl.calendar.BaseCalendar
This implementation of the Calendar may be used (you don't have to) as a base class for more sophisticated one's. It merely implements the base functionality required by each Calendar.
Regarded as base functionality is the treatment of base calendars. Base calendar allow you to chain (stack) as much calendars as you may need. For example to exclude weekends you may use WeeklyCalendar. In order to exclude holidays as well you may define a WeeklyCalendar instance to be the base calendar for HolidayCalendar instance.
Calendar
,
Serialized FormField Summary |
Fields inherited from interface org.quartz.Calendar |
MONTH |
Constructor Summary | |
BaseCalendar()
Default Constructor |
|
BaseCalendar(Calendar baseCalendar)
Constructor |
Method Summary | |
static java.util.Date |
buildHoliday(java.util.Date excludedDate)
Utility method. |
static long |
buildHoliday(long timeStamp)
Utility method. |
Calendar |
getBaseCalendar()
Get the base calendar. |
java.lang.String |
getDescription()
Return the description given to the Calendar instance by
its creator (if any). |
static java.util.Calendar |
getJavaCalendar(long timeStamp)
Utility method. |
long |
getNextIncludedTime(long timeStamp)
Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time. |
boolean |
isTimeIncluded(long timeStamp)
Check if date/time represented by timeStamp is included. |
void |
setBaseCalendar(Calendar baseCalendar)
Set a new base calendar or remove the existing one |
void |
setDescription(java.lang.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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public BaseCalendar()
Default Constructor
public BaseCalendar(Calendar baseCalendar)
Constructor
Method Detail |
public void setBaseCalendar(Calendar baseCalendar)
Set a new base calendar or remove the existing one
setBaseCalendar
in interface Calendar
public Calendar getBaseCalendar()
Get the base calendar. Will be null, if not set.
getBaseCalendar
in interface Calendar
public java.lang.String getDescription()
Return the description given to the Calendar
instance by
its creator (if any).
getDescription
in interface Calendar
public void setDescription(java.lang.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.
setDescription
in interface Calendar
public boolean isTimeIncluded(long timeStamp)
Check if date/time represented by timeStamp is included. If included return true. The implementation of BaseCalendar simply calls the base calendars isTimeIncluded() method if base calendar is set.
isTimeIncluded
in interface Calendar
Calendar.isTimeIncluded(long)
public long getNextIncludedTime(long timeStamp)
Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time. Return the original value if timeStamp is included. Return 0 if all days are excluded.
getNextIncludedTime
in interface Calendar
Calendar.getNextIncludedTime(long)
public static java.util.Date buildHoliday(java.util.Date excludedDate)
Utility method. Return the date of excludeDate. The time fraction will be reset to 00.00:00.
public static long buildHoliday(long timeStamp)
Utility method. Return just the date of excludeDate. The time fraction will be reset to 00.00:00.
public static java.util.Calendar getJavaCalendar(long timeStamp)
Utility method. Return a java.util.Calendar for timeStamp.
timeStamp
-
|
Quartz Project Page | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |