com.helger.quartz.impl.calendar

Class AbstractCalendar<IMPLTYPE extends AbstractCalendar<IMPLTYPE>>

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AnnualCalendar, CronCalendar, DailyCalendar, HolidayCalendar, MonthlyCalendar, WeeklyCalendar

public abstract class AbstractCalendar<IMPLTYPE extends AbstractCalendar<IMPLTYPE>>
extends Object
implements ICalendar, com.helger.commons.lang.ICloneable<IMPLTYPE>

This implementation of the Calendar may be used (you don't have to) as a base class for more sophisticated one's. It merely implements the base functionality required by each Calendar.

Regarded as base functionality is the treatment of base calendars. Base calendar allow you to chain (stack) as much calendars as you may need. For example to exclude weekends you may use WeeklyCalendar. In order to exclude holidays as well you may define a WeeklyCalendar instance to be the base calendar for HolidayCalendar instance.

Author:

Juergen Donnerstag, James House

See Also:

ICalendar

Field Summary

Fields inherited from interface com.helger.quartz.ICalendar

MONTH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCalendar(AbstractCalendar<IMPLTYPE> aOther) Copy constructor
	AbstractCalendar(ICalendar aBaseCalendar, TimeZone aTimeZone)

Method Summary

Modifier and Type	Method and Description
protected Calendar	createJavaCalendar() Build a Calendar with the current time.
protected Calendar	createJavaCalendar(long timeStamp) Build a Calendar for the given timeStamp.
ICalendar	getBaseCalendar() Get the base calendar.
String	getDescription() Return the description given to the Calendar instance by its creator (if any).
protected Calendar	getEndOfDayJavaCalendar(long timeInMillis) Returns the end of the given day Calendar.
long	getNextIncludedTime(long timeStamp) Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time.
protected Calendar	getStartOfDayJavaCalendar(long timeInMillis) Returns the start of the given day as a Calendar.
TimeZone	getTimeZone()
boolean	isTimeIncluded(long timeStamp) Check if date/time represented by timeStamp is included.
void	setBaseCalendar(ICalendar baseCalendar) Set a new base calendar or remove the existing one.
void	setDescription(String description) Set a description for the Calendar instance - may be useful for remembering/displaying the purpose of the calendar, though the description has no meaning to Quartz.
void	setTimeZone(TimeZone timeZone)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.quartz.ICalendar

getClone

Methods inherited from interface com.helger.commons.lang.ICloneable

getClone

Constructor Detail

AbstractCalendar

protected AbstractCalendar(@Nonnull
                           AbstractCalendar<IMPLTYPE> aOther)

Copy constructor

Parameters:

aOther - Calendar to copy from. May not be null.

AbstractCalendar

public AbstractCalendar(@Nullable
                        ICalendar aBaseCalendar,
                        @Nullable
                        TimeZone aTimeZone)

Parameters:

aBaseCalendar - Base calendar to use. May be null.

aTimeZone - The time zone to use for this Calendar, null if TimeZone.getDefault() should be used

Method Detail

getBaseCalendar

public final ICalendar getBaseCalendar()

Description copied from interface: ICalendar

Get the base calendar. Will be null, if not set.

Specified by:

getBaseCalendar in interface ICalendar

setBaseCalendar

public final void setBaseCalendar(@Nullable
                                  ICalendar baseCalendar)

Description copied from interface: ICalendar

Set a new base calendar or remove the existing one.

Specified by:

setBaseCalendar in interface ICalendar

Parameters:

baseCalendar - The new base calendar. May be null.

getDescription

public final String getDescription()

Description copied from interface: ICalendar

Return the description given to the Calendar instance by its creator (if any).

Specified by:

getDescription in interface ICalendar

Returns:

null if no description was set.

setDescription

public final void setDescription(@Nullable
                                 String description)

Description copied from interface: ICalendar

Set a description for the Calendar instance - may be useful for remembering/displaying the purpose of the calendar, though the description has no meaning to Quartz.

Specified by:

setDescription in interface ICalendar

Parameters:

description - The new description. May be null.

getTimeZone

@Nullable
public TimeZone getTimeZone()

setTimeZone

public void setTimeZone(@Nullable
                        TimeZone timeZone)

isTimeIncluded

public boolean isTimeIncluded(long timeStamp)

Check if date/time represented by timeStamp is included. If included return true. The implementation of AbstractCalendar simply calls the base calendars isTimeIncluded() method if base calendar is set.

Specified by:

isTimeIncluded in interface ICalendar

See Also:

ICalendar.isTimeIncluded(long)

getNextIncludedTime

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.

Specified by:

getNextIncludedTime in interface ICalendar

See Also:

ICalendar.getNextIncludedTime(long)

createJavaCalendar

protected final Calendar createJavaCalendar(long timeStamp)

Build a Calendar for the given timeStamp. The new Calendar will use the AbstractCalendar time zone if it is not null.

createJavaCalendar

protected final Calendar createJavaCalendar()

Build a Calendar with the current time. The new Calendar will use the AbstractCalendar time zone if it is not null.

getStartOfDayJavaCalendar

protected final Calendar getStartOfDayJavaCalendar(long timeInMillis)

Returns the start of the given day as a Calendar. This calculation will take the AbstractCalendar time zone into account if it is not null.

Parameters:

timeInMillis - A time containing the desired date for the start-of-day time

Returns:

A Calendar set to the start of the given day.

getEndOfDayJavaCalendar

protected final Calendar getEndOfDayJavaCalendar(long timeInMillis)

Returns the end of the given day Calendar. This calculation will take the AbstractCalendar time zone into account if it is not null.

Parameters:

timeInMillis - a time containing the desired date for the end-of-day time.

Returns:

A Calendar set to the end of the given day.