com.helger.quartz.impl.calendar

Class WeeklyCalendar

java.lang.Object

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

com.helger.quartz.impl.calendar.WeeklyCalendar

All Implemented Interfaces:

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

public class WeeklyCalendar
extends AbstractCalendar<WeeklyCalendar>

This implementation of the Calendar excludes a set of days of the week. You may use it to exclude weekends for example. But you may define any day of the week. By default it excludes SATURDAY and SUNDAY.

Author:

Juergen Donnerstag

See Also:

ICalendar, AbstractCalendar

Field Summary

Fields inherited from interface com.helger.quartz.ICalendar

MONTH

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	areAllDaysExcluded() Check if all week days are excluded.
WeeklyCalendar	getClone()
boolean[]	getDaysExcluded() Get the array with the week days
long	getNextIncludedTime(long nTimeStamp) Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time.
boolean	isDayExcluded(int wday) Return true, if wday (see Calendar.get()) is defined to be exluded.
boolean	isTimeIncluded(long timeStamp) Determine whether the given time (in milliseconds) is 'included' by the Calendar.
void	setDayExcluded(int wday, boolean exclude) Redefine a certain day of the week to be excluded (true) or included (false).
void	setDaysExcluded(boolean[] weekDays) 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

WeeklyCalendar

public WeeklyCalendar(@Nonnull
                      WeeklyCalendar aOther)

WeeklyCalendar

public WeeklyCalendar()

WeeklyCalendar

public WeeklyCalendar(ICalendar baseCalendar)

WeeklyCalendar

public WeeklyCalendar(TimeZone timeZone)

WeeklyCalendar

public WeeklyCalendar(ICalendar baseCalendar,
                      TimeZone timeZone)

Method Detail

getDaysExcluded

public boolean[] getDaysExcluded()

Get the array with the week days

isDayExcluded

public boolean isDayExcluded(int wday)

Return true, if wday (see Calendar.get()) is defined to be exluded. E. g. saturday and sunday.

setDaysExcluded

public void setDaysExcluded(boolean[] weekDays)

Redefine the array of days excluded. The array must of size greater or equal 8. Calendar's constants like MONDAY should be used as index. A value of true is regarded as: exclude it.

setDayExcluded

public void setDayExcluded(int wday,
                           boolean exclude)

Redefine a certain day of the week to be excluded (true) or included (false). Use Calendar's constants like MONDAY to determine the wday.

areAllDaysExcluded

public boolean areAllDaysExcluded()

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

Returns:

boolean

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<WeeklyCalendar>

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<WeeklyCalendar>

See Also:

ICalendar.getNextIncludedTime(long)

getClone

@Nonnull
public WeeklyCalendar getClone()