com.helger.quartz.impl.calendar

Class AnnualCalendar

java.lang.Object

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

com.helger.quartz.impl.calendar.AnnualCalendar

All Implemented Interfaces:

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

public class AnnualCalendar
extends AbstractCalendar<AnnualCalendar>

This implementation of the Calendar excludes a set of days of the year. You may use it to exclude bank holidays which are on the same date every year.

Author:

Juergen Donnerstag

See Also:

ICalendar, AbstractCalendar

Field Summary

Fields inherited from interface com.helger.quartz.ICalendar

MONTH

Constructor Summary

Constructors

Constructor and Description
AnnualCalendar()
AnnualCalendar(AnnualCalendar aRhs)
AnnualCalendar(ICalendar baseCalendar)
AnnualCalendar(ICalendar baseCalendar, TimeZone timeZone)
AnnualCalendar(TimeZone timeZone)

Method Summary

Modifier and Type	Method and Description
AnnualCalendar	getClone()
com.helger.commons.collection.impl.ICommonsList<Calendar>	getDaysExcluded()
long	getNextIncludedTime(long nTimeStamp) Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time.
boolean	isDayExcluded(Calendar day)
boolean	isTimeIncluded(long timeStamp) Determine whether the given time (in milliseconds) is 'included' by the Calendar.
void	removeExcludedDay(Calendar day) Remove the given day from the list of excluded days
void	setDayExcluded(Calendar day, boolean exclude) Redefine a certain day to be excluded (true) or included (false).
void	setDaysExcluded(List<Calendar> days) Redefine the list 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

AnnualCalendar

public AnnualCalendar(@Nonnull
                      AnnualCalendar aRhs)

AnnualCalendar

public AnnualCalendar()

AnnualCalendar

public AnnualCalendar(ICalendar baseCalendar)

AnnualCalendar

public AnnualCalendar(TimeZone timeZone)

AnnualCalendar

public AnnualCalendar(ICalendar baseCalendar,
                      TimeZone timeZone)

Method Detail

getDaysExcluded

@ReturnsMutableObject
public com.helger.commons.collection.impl.ICommonsList<Calendar> getDaysExcluded()

Returns:

Get the list which defines the exclude-value of each day of month

isDayExcluded

public boolean isDayExcluded(@Nonnull
                             Calendar day)

Parameters:

day - day to check. May not be null.

Returns:

true if day is defined to be excluded.

setDaysExcluded

public void setDaysExcluded(@Nullable
                            List<Calendar> days)

Redefine the list of days excluded. The ArrayList should contain Calendar objects.

Parameters:

days - The days to be excluded

setDayExcluded

public void setDayExcluded(Calendar day,
                           boolean exclude)

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

removeExcludedDay

public void removeExcludedDay(Calendar day)

Remove the given day from the list of excluded days

Parameters:

day - the day to exclude

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

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

See Also:

ICalendar.getNextIncludedTime(long)

getClone

@Nonnull
 @ReturnsMutableCopy
public AnnualCalendar getClone()