|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.quartz.impl.calendar.BaseCalendar org.quartz.impl.calendar.MonthlyCalendar
public class MonthlyCalendar
This implementation of the Calendar excludes a set of days of the month. You may use it to exclude every first day of each month for example. But you may define any day of a month.
Calendar
,
BaseCalendar
,
Serialized FormField Summary |
---|
Fields inherited from interface org.quartz.Calendar |
---|
MONTH |
Constructor Summary | |
---|---|
MonthlyCalendar()
|
|
MonthlyCalendar(Calendar baseCalendar)
|
|
MonthlyCalendar(Calendar baseCalendar,
TimeZone timeZone)
|
|
MonthlyCalendar(TimeZone timeZone)
|
Method Summary | |
---|---|
boolean |
areAllDaysExcluded()
Check if all days are excluded. |
Object |
clone()
|
boolean[] |
getDaysExcluded()
Get the array which defines the exclude-value of each day of month. |
long |
getNextIncludedTime(long timeStamp)
Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time. |
boolean |
isDayExcluded(int day)
Return true, if day is defined to be excluded. |
boolean |
isTimeIncluded(long timeStamp)
Determine whether the given time (in milliseconds) is 'included' by the Calendar. |
void |
setDayExcluded(int day,
boolean exclude)
Redefine a certain day of the month to be excluded (true) or included (false). |
void |
setDaysExcluded(boolean[] days)
Redefine the array of days excluded. |
Methods inherited from class org.quartz.impl.calendar.BaseCalendar |
---|
createJavaCalendar, createJavaCalendar, getBaseCalendar, getDescription, getEndOfDayJavaCalendar, getStartOfDayJavaCalendar, getTimeZone, setBaseCalendar, setDescription, setTimeZone |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.quartz.Calendar |
---|
getBaseCalendar, getDescription, setBaseCalendar, setDescription |
Constructor Detail |
---|
public MonthlyCalendar()
public MonthlyCalendar(Calendar baseCalendar)
public MonthlyCalendar(TimeZone timeZone)
public MonthlyCalendar(Calendar baseCalendar, TimeZone timeZone)
Method Detail |
---|
public Object clone()
clone
in interface Calendar
clone
in class BaseCalendar
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 boolean isDayExcluded(int day)
Return true, if day is defined to be excluded.
day
- The day of the month (from 1 to 31) to check.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.
public void setDayExcluded(int day, boolean exclude)
Redefine a certain day of the month to be excluded (true) or included (false).
day
- The day of the month (from 1 to 31) to set.public boolean areAllDaysExcluded()
Check if all days are excluded. That is no day is included.
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.
isTimeIncluded
in interface Calendar
isTimeIncluded
in class BaseCalendar
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.
Note that this Calendar is only has full-day precision.
getNextIncludedTime
in interface Calendar
getNextIncludedTime
in class BaseCalendar
Calendar.getNextIncludedTime(long)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |