com.helger.quartz.impl.calendar

Class MonthlyCalendar

java.lang.Object

com.helger.quartz.impl.calendar.AbstractCalendar<MonthlyCalendar>

com.helger.quartz.impl.calendar.MonthlyCalendar

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<MonthlyCalendar>, ICalendar

public class MonthlyCalendar
extends AbstractCalendar<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.

Author:

Juergen Donnerstag

See Also:

ICalendar, AbstractCalendar

Field Summary

Fields inherited from interface com.helger.quartz.ICalendar

MONTH

Constructor Summary

Constructors

Constructor and Description
MonthlyCalendar()
MonthlyCalendar(ICalendar baseCalendar)
MonthlyCalendar(ICalendar baseCalendar, TimeZone timeZone)
MonthlyCalendar(MonthlyCalendar aOther)
MonthlyCalendar(TimeZone timeZone)

Method Summary

Modifier and Type	Method and Description
boolean	areAllDaysExcluded() Check if all days are excluded.
MonthlyCalendar	getClone()
boolean[]	getDaysExcluded() Get the array which defines the exclude-value of each day of month.
long	getNextIncludedTime(long nTimeStamp) 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 com.helger.quartz.impl.calendar.AbstractCalendar

createJavaCalendar, createJavaCalendar, getBaseCalendar, getDescription, getEndOfDayJavaCalendar, getStartOfDayJavaCalendar, getTimeZone, setBaseCalendar, setDescription, setTimeZone

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MonthlyCalendar

public MonthlyCalendar(@Nonnull
                       MonthlyCalendar aOther)

MonthlyCalendar

public MonthlyCalendar()

MonthlyCalendar

public MonthlyCalendar(ICalendar baseCalendar)

MonthlyCalendar

public MonthlyCalendar(TimeZone timeZone)

MonthlyCalendar

public MonthlyCalendar(ICalendar baseCalendar,
                       TimeZone timeZone)

Method Detail

getDaysExcluded

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.

isDayExcluded

public boolean isDayExcluded(int day)

Return true, if day is defined to be excluded.

Parameters:

day - The day of the month (from 1 to 31) to check.

setDaysExcluded

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.

setDayExcluded

public void setDayExcluded(int day,
                           boolean exclude)

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

Parameters:

day - The day of the month (from 1 to 31) to set.

areAllDaysExcluded

public boolean areAllDaysExcluded()

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

isTimeIncluded

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.

Specified by:

isTimeIncluded in interface ICalendar

Overrides:

isTimeIncluded in class AbstractCalendar<MonthlyCalendar>

See Also:

ICalendar.isTimeIncluded(long)

getNextIncludedTime

public long getNextIncludedTime(long nTimeStamp)

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.

Specified by:

getNextIncludedTime in interface ICalendar

Overrides:

getNextIncludedTime in class AbstractCalendar<MonthlyCalendar>

See Also:

ICalendar.getNextIncludedTime(long)

getClone

@Nonnull
public MonthlyCalendar getClone()