org.quartz.xml

Class CalendarBundle

java.lang.Object

org.quartz.xml.CalendarBundle

All Implemented Interfaces:

java.io.Serializable, Calendar

public class CalendarBundle
extends java.lang.Object
implements Calendar

Wraps a Calendar.

Author:

Chris Bonham

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.quartz.Calendar

MONTH

Constructor Summary

Constructors

Constructor and Description
CalendarBundle()

Method Summary

Methods

Modifier and Type	Method and Description
Calendar	getBaseCalendar() Get the base calendar.
Calendar	getCalendar()
java.lang.String	getCalendarName()
java.lang.String	getClassName()
java.lang.String	getDescription() Return the description given to the Calendar instance by its creator (if any).
long	getNextIncludedTime(long timeStamp) Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time.
boolean	getReplace()
boolean	isTimeIncluded(long timeStamp) Determine whether the given time (in milliseconds) is 'included' by the Calendar.
void	setBaseCalendar(Calendar baseCalendar) Set a new base calendar or remove the existing one.
void	setCalendar(Calendar calendar)
void	setCalendarName(java.lang.String calendarName)
void	setClassName(java.lang.String className)
void	setDescription(java.lang.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	setReplace(boolean replace)

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarBundle

public CalendarBundle()

Method Detail

getCalendarName

public java.lang.String getCalendarName()

setCalendarName

public void setCalendarName(java.lang.String calendarName)

getClassName

public java.lang.String getClassName()

setClassName

public void setClassName(java.lang.String className)
                  throws java.lang.ClassNotFoundException,
                         java.lang.InstantiationException,
                         java.lang.IllegalAccessException

Throws:

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

getCalendar

public Calendar getCalendar()

setCalendar

public void setCalendar(Calendar calendar)

getReplace

public boolean getReplace()

setReplace

public void setReplace(boolean replace)

getBaseCalendar

public Calendar getBaseCalendar()

Description copied from interface: Calendar

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

Specified by:

getBaseCalendar in interface Calendar

setBaseCalendar

public void setBaseCalendar(Calendar baseCalendar)

Description copied from interface: Calendar

Set a new base calendar or remove the existing one.

Specified by:

setBaseCalendar in interface Calendar

getDescription

public java.lang.String getDescription()

Description copied from interface: Calendar

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

Specified by:

getDescription in interface Calendar

Returns:

null if no description was set.

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: Calendar

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 Calendar

isTimeIncluded

public boolean isTimeIncluded(long timeStamp)

Description copied from interface: Calendar

Determine whether the given time (in milliseconds) is 'included' by the Calendar.

Specified by:

isTimeIncluded in interface Calendar

getNextIncludedTime

public long getNextIncludedTime(long timeStamp)

Description copied from interface: Calendar

Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time.

Specified by:

getNextIncludedTime in interface Calendar