Home » quartz-1.6.0 » org » quartz » impl » calendar » [javadoc | source]
org.quartz.impl.calendar
public class: HolidayCalendar [javadoc | source]
java.lang.Object
   org.quartz.impl.calendar.BaseCalendar
      org.quartz.impl.calendar.HolidayCalendar

All Implemented Interfaces:
    Serializable, Calendar

This implementation of the Calendar stores a list of holidays (full days that are excluded from scheduling).

The implementation DOES take the year into consideration, so if you want to exclude July 4th for the next 10 years, you need to add 10 entries to the exclude list.

Field Summary
static final  long serialVersionUID     
Fields inherited from org.quartz.impl.calendar.BaseCalendar:
serialVersionUID
Constructor:
 public HolidayCalendar() 
 public HolidayCalendar(Calendar baseCalendar) 
 public HolidayCalendar(TimeZone timeZone) 
 public HolidayCalendar(Calendar baseCalendar,
    TimeZone timeZone) 
Method from org.quartz.impl.calendar.HolidayCalendar Summary:
addExcludedDate,   getExcludedDates,   getNextIncludedTime,   isTimeIncluded,   removeExcludedDate
Methods from org.quartz.impl.calendar.BaseCalendar:
buildHoliday,   buildHoliday,   createJavaCalendar,   createJavaCalendar,   getBaseCalendar,   getDescription,   getEndOfDayJavaCalendar,   getJavaCalendar,   getNextIncludedTime,   getStartOfDayJavaCalendar,   getTimeZone,   isTimeIncluded,   setBaseCalendar,   setDescription,   setTimeZone
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.quartz.impl.calendar.HolidayCalendar Detail:
 public  void addExcludedDate(Date excludedDate) 

    Add the given Date to the list of excluded days. Only the month, day and year of the returned dates are significant.

 public SortedSet getExcludedDates() 

    Returns a SortedSet of Dates representing the excluded days. Only the month, day and year of the returned dates are significant.

 public long getNextIncludedTime(long timeStamp) 

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

    Note that this Calendar is only has full-day precision.

 public boolean isTimeIncluded(long timeStamp) 

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

    Note that this Calendar is only has full-day precision.

 public  void removeExcludedDate(Date dateToRemove)