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

All Implemented Interfaces:
    Serializable, Calendar

This implementation of the Calendar excludes a set of days of the month. You may use it to exclude every 1. of each month for example. But you may define any day of a month.

Field Summary
static final  long serialVersionUID     
Fields inherited from org.quartz.impl.calendar.BaseCalendar:
serialVersionUID
Constructor:
 public MonthlyCalendar() 
 public MonthlyCalendar(Calendar baseCalendar) 
 public MonthlyCalendar(TimeZone timeZone) 
 public MonthlyCalendar(Calendar baseCalendar,
    TimeZone timeZone) 
Method from org.quartz.impl.calendar.MonthlyCalendar Summary:
areAllDaysExcluded,   getDaysExcluded,   getNextIncludedTime,   isDayExcluded,   isTimeIncluded,   setDayExcluded,   setDaysExcluded
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.MonthlyCalendar Detail:
 public boolean areAllDaysExcluded() 

    Check if all days are excluded. That is no day is included.

 public boolean[] getDaysExcluded() 

    Get the array which defines the exclude-value of each day of month. Only the first 31 elements of the array are relevant, with the 0 index element representing the first day of the month.

 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.

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

 public boolean isDayExcluded(int day) 

    Return true, if day is defined to be excluded.

 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 setDayExcluded(int day,
    boolean exclude) 

    Redefine a certain day of the month to be excluded (true) or included (false).

 public  void setDaysExcluded(boolean[] days) 

    Redefine the array of days excluded. The array must non-null and of size greater or equal to 31. The 0 index element represents the first day of the month.