com.helger.quartz.impl.calendar

Class CronCalendar

java.lang.Object

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

com.helger.quartz.impl.calendar.CronCalendar

All Implemented Interfaces:

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

public class CronCalendar
extends AbstractCalendar<CronCalendar>

This implementation of the Calendar excludes the set of times expressed by a given CronExpression. For example, you could use this calendar to exclude all but business hours (8AM - 5PM) every day using the expression "* * 0-7,18-23 ? * *".

It is important to remember that the cron expression here describes a set of times to be excluded from firing. Whereas the cron expression in CronTrigger describes a set of times that can be included for firing. Thus, if a CronTrigger has a given cron expression and is associated with a CronCalendar with the same expression, the calendar will exclude all the times the trigger includes, and they will cancel each other out.

Author:

Aaron Craven

Field Summary

Fields inherited from interface com.helger.quartz.ICalendar

MONTH

Constructor Summary

Constructors

Constructor and Description
CronCalendar(CronCalendar aOther)
CronCalendar(ICalendar baseCalendar, String expression) Create a CronCalendar with the given cron expression and baseCalendar.
CronCalendar(ICalendar baseCalendar, String expression, TimeZone timeZone) Create a CronCalendar with the given cron exprssion, baseCalendar, and TimeZone.
CronCalendar(String expression) Create a CronCalendar with the given cron expression and no baseCalendar.

Method Summary

Modifier and Type	Method and Description
CronCalendar	getClone()
CronExpression	getCronExpression() Returns the object representation of the cron expression that defines the dates and times this calendar excludes.
long	getNextIncludedTime(long timeInMillis) Determines the next time included by the CronCalendar after the specified time.
TimeZone	getTimeZone() Returns the time zone for which the CronExpression of this CronCalendar will be resolved.
boolean	isTimeIncluded(long timeInMillis) Determines whether the given time (in milliseconds) is 'included' by the AbstractCalendar
void	setCronExpression(CronExpression expression) Sets the cron expression for the calendar to a new value
void	setCronExpression(String expression) Sets the cron expression for the calendar to a new value
void	setTimeZone(TimeZone timeZone) Sets the time zone for which the CronExpression of this CronCalendar will be resolved.
String	toString() Returns a string representing the properties of the CronCalendar

Methods inherited from class com.helger.quartz.impl.calendar.AbstractCalendar

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CronCalendar

public CronCalendar(@Nonnull
                    CronCalendar aOther)

CronCalendar

public CronCalendar(String expression)
             throws ParseException

Create a CronCalendar with the given cron expression and no baseCalendar.

Parameters:

expression - a String representation of the desired cron expression

Throws:

ParseException

CronCalendar

public CronCalendar(ICalendar baseCalendar,
                    String expression)
             throws ParseException

Create a CronCalendar with the given cron expression and baseCalendar.

Parameters:

baseCalendar - the base calendar for this calendar instance – see AbstractCalendar for more information on base calendar functionality

expression - a String representation of the desired cron expression

Throws:

ParseException

CronCalendar

public CronCalendar(ICalendar baseCalendar,
                    String expression,
                    TimeZone timeZone)
             throws ParseException

Create a CronCalendar with the given cron exprssion, baseCalendar, and TimeZone.

Parameters:

baseCalendar - the base calendar for this calendar instance – see AbstractCalendar for more information on base calendar functionality

expression - a String representation of the desired cron expression

timeZone - Specifies for which time zone the expression should be interpreted, i.e. the expression 0 0 10 * * ?, is resolved to 10:00 am in this time zone. If timeZone is null then TimeZone.getDefault() will be used.

Throws:

ParseException

Method Detail

getTimeZone

public TimeZone getTimeZone()

Returns the time zone for which the CronExpression of this CronCalendar will be resolved.

Overrides AbstractCalendar.getTimeZone() to defer to its CronExpression.

Overrides:

getTimeZone in class AbstractCalendar<CronCalendar>

setTimeZone

public void setTimeZone(TimeZone timeZone)

Sets the time zone for which the CronExpression of this CronCalendar will be resolved. If timeZone is null then TimeZone.getDefault() will be used.

Overrides AbstractCalendar.setTimeZone(TimeZone) to defer to its CronExpression.

Overrides:

setTimeZone in class AbstractCalendar<CronCalendar>

isTimeIncluded

public boolean isTimeIncluded(long timeInMillis)

Determines whether the given time (in milliseconds) is 'included' by the AbstractCalendar

Specified by:

isTimeIncluded in interface ICalendar

Overrides:

isTimeIncluded in class AbstractCalendar<CronCalendar>

Parameters:

timeInMillis - the date/time to test

Returns:

a boolean indicating whether the specified time is 'included' by the CronCalendar

See Also:

ICalendar.isTimeIncluded(long)

getNextIncludedTime

public long getNextIncludedTime(long timeInMillis)

Determines the next time included by the CronCalendar after the specified time.

Specified by:

getNextIncludedTime in interface ICalendar

Overrides:

getNextIncludedTime in class AbstractCalendar<CronCalendar>

Parameters:

timeInMillis - the initial date/time after which to find an included time

Returns:

the time in milliseconds representing the next time included after the specified time.

See Also:

ICalendar.getNextIncludedTime(long)

toString

public String toString()

Returns a string representing the properties of the CronCalendar

Overrides:

toString in class Object

Returns:

the properties of the CronCalendar in a String format

getCronExpression

@Nonnull
public CronExpression getCronExpression()

Returns the object representation of the cron expression that defines the dates and times this calendar excludes.

Returns:

the cron expression

See Also:

CronExpression

setCronExpression

public void setCronExpression(@Nonnull
                              String expression)
                       throws ParseException

Sets the cron expression for the calendar to a new value

Parameters:

expression - the new string value to build a cron expression from

Throws:

ParseException - if the string expression cannot be parsed

setCronExpression

public void setCronExpression(@Nonnull
                              CronExpression expression)

Sets the cron expression for the calendar to a new value

Parameters:

expression - the new cron expression

getClone

@Nonnull
public CronCalendar getClone()