org.quartz.impl.calendar
Class AnnualCalendar

java.lang.Object
  extended byorg.quartz.impl.calendar.BaseCalendar
      extended byorg.quartz.impl.calendar.AnnualCalendar
All Implemented Interfaces:
Calendar, java.io.Serializable

public class AnnualCalendar
extends BaseCalendar
implements Calendar, java.io.Serializable

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:
Calendar, BaseCalendar, Serialized Form

Field Summary
 
Fields inherited from interface org.quartz.Calendar
MONTH
 
Constructor Summary
AnnualCalendar()
           Constructor
AnnualCalendar(Calendar baseCalendar)
           Constructor
 
Method Summary
 java.util.ArrayList getDaysExcluded()
           Get the array which defines the exclude-value of each day of month
 long getNextIncludedTime(long timeStamp)
           Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time.
 boolean isDayExcluded(java.util.Calendar day)
           Return true, if day is defined to be exluded.
 boolean isTimeIncluded(long timeStamp)
           Determine whether the given time (in milliseconds) is 'included' by the Calendar.
 void setDayExcluded(java.util.Calendar day, boolean exclude)
           Redefine a certain day to be excluded (true) or included (false).
 void setDaysExcluded(java.util.ArrayList days)
           Redefine the array of days excluded.
 
Methods inherited from class org.quartz.impl.calendar.BaseCalendar
buildHoliday, buildHoliday, getBaseCalendar, getDescription, getJavaCalendar, setBaseCalendar, setDescription
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.quartz.Calendar
getBaseCalendar, getDescription, setBaseCalendar, setDescription
 

Constructor Detail

AnnualCalendar

public AnnualCalendar()

Constructor


AnnualCalendar

public AnnualCalendar(Calendar baseCalendar)

Constructor

Method Detail

getDaysExcluded

public java.util.ArrayList getDaysExcluded()

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


isDayExcluded

public boolean isDayExcluded(java.util.Calendar day)

Return true, if day is defined to be exluded.


setDaysExcluded

public void setDaysExcluded(java.util.ArrayList days)

Redefine the array of days excluded. The array must of size greater or equal 31.


setDayExcluded

public void setDayExcluded(java.util.Calendar day,
                           boolean exclude)

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


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 Calendar
Overrides:
isTimeIncluded in class BaseCalendar
See Also:
Calendar.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.

Note that this Calendar is only has full-day precision.

Specified by:
getNextIncludedTime in interface Calendar
Overrides:
getNextIncludedTime in class BaseCalendar
See Also:
Calendar.getNextIncludedTime(long)

Quartz Project Page