Home » quartz-1.6.0 » org » quartz » impl » calendar » [javadoc | source]
org.quartz.impl.calendar
public class: DailyCalendar [javadoc | source]
java.lang.Object
   org.quartz.impl.calendar.BaseCalendar
      org.quartz.impl.calendar.DailyCalendar

All Implemented Interfaces:
    Serializable, Calendar

This implementation of the Calendar excludes (or includes - see below) a specified time range each day. For example, you could use this calendar to exclude business hours (8AM - 5PM) every day. Each DailyCalendar only allows a single time range to be specified, and that time range may not cross daily boundaries (i.e. you cannot specify a time range from 8PM - 5AM). If the property invertTimeRange is false (default), the time range defines a range of times in which triggers are not allowed to fire. If invertTimeRange is true, the time range is inverted – that is, all times outside the defined time range are excluded.

Note when using DailyCalendar, it behaves on the same principals as, for example, WeeklyCalendar . WeeklyCalendar defines a set of days that are excluded every week. Likewise, DailyCalendar defines a set of times that are excluded every day.

Field Summary
static final  long serialVersionUID     
Fields inherited from org.quartz.impl.calendar.BaseCalendar:
serialVersionUID
Constructor:
 public DailyCalendar(String rangeStartingTime,
    String rangeEndingTime) 
    Create a DailyCalendar with a time range defined by the specified strings and no baseCalendar. rangeStartingTime and rangeEndingTime must be in the format "HH:MM[:SS[:mmm]]" where:
    • HH is the hour of the specified time. The hour should be specified using military (24-hour) time and must be in the range 0 to 23.
    • MM is the minute of the specified time and must be in the range 0 to 59.
    • SS is the second of the specified time and must be in the range 0 to 59.
    • mmm is the millisecond of the specified time and must be in the range 0 to 999.
    • items enclosed in brackets ('[', ']') are optional.
    • The time range starting time must be before the time range ending time. Note this means that a time range may not cross daily boundaries (10PM - 2AM)

    Note: This DailyCalendar will use the TimeZone#getDefault() time zone unless an explicit time zone is set via BaseCalendar#setTimeZone(TimeZone)

    Parameters:
    rangeStartingTime - a String representing the starting time for the time range
    rangeEndingTime - a String representing the ending time for the the time range
 public DailyCalendar(Calendar rangeStartingCalendar,
    Calendar rangeEndingCalendar) 
    Create a DailyCalendar with a time range defined by the specified java.util.Calendars and no baseCalendar. The Calendars are subject to the following considerations:
    • Only the time-of-day fields of the specified Calendars will be used (the date fields will be ignored)
    • The starting time must be before the ending time of the defined time range. Note this means that a time range may not cross daily boundaries (10PM - 2AM). (because only time fields are are used, it is possible for two Calendars to represent a valid time range and rangeStartingCalendar.after(rangeEndingCalendar) == true)

    Note: This DailyCalendar will use the TimeZone#getDefault() time zone unless an explicit time zone is set via BaseCalendar#setTimeZone(TimeZone)

    Parameters:
    rangeStartingCalendar - a java.util.Calendar representing the starting time for the time range
    rangeEndingCalendar - a java.util.Calendar representing the ending time for the time range
 public DailyCalendar(long rangeStartingTimeInMillis,
    long rangeEndingTimeInMillis) 
    Parameters:
    rangeStartingTimeInMillis - a long representing the starting time for the time range
    rangeEndingTimeInMillis - a long representing the ending time for the time range
 public DailyCalendar(Calendar baseCalendar,
    String rangeStartingTime,
    String rangeEndingTime) 
    Create a DailyCalendar with a time range defined by the specified strings and the specified baseCalendar. rangeStartingTime and rangeEndingTime must be in the format "HH:MM[:SS[:mmm]]" where:
    • HH is the hour of the specified time. The hour should be specified using military (24-hour) time and must be in the range 0 to 23.
    • MM is the minute of the specified time and must be in the range 0 to 59.
    • SS is the second of the specified time and must be in the range 0 to 59.
    • mmm is the millisecond of the specified time and must be in the range 0 to 999.
    • items enclosed in brackets ('[', ']') are optional.
    • The time range starting time must be before the time range ending time. Note this means that a time range may not cross daily boundaries (10PM - 2AM)

    Note: This DailyCalendar will use the TimeZone#getDefault() time zone unless an explicit time zone is set via BaseCalendar#setTimeZone(TimeZone)

    Parameters:
    baseCalendar - the base calendar for this calendar instance – see BaseCalendar for more information on base calendar functionality
    rangeStartingTime - a String representing the starting time for the time range
    rangeEndingTime - a String representing the ending time for the time range
 public DailyCalendar(Calendar baseCalendar,
    Calendar rangeStartingCalendar,
    Calendar rangeEndingCalendar) 
    Create a DailyCalendar with a time range defined by the specified java.util.Calendars and the specified baseCalendar. The Calendars are subject to the following considerations:
    • Only the time-of-day fields of the specified Calendars will be used (the date fields will be ignored)
    • The starting time must be before the ending time of the defined time range. Note this means that a time range may not cross daily boundaries (10PM - 2AM). (because only time fields are are used, it is possible for two Calendars to represent a valid time range and rangeStartingCalendar.after(rangeEndingCalendar) == true)

    Note: This DailyCalendar will use the TimeZone#getDefault() time zone unless an explicit time zone is set via BaseCalendar#setTimeZone(TimeZone)

    Parameters:
    baseCalendar - the base calendar for this calendar instance – see BaseCalendar for more information on base calendar functionality
    rangeStartingCalendar - a java.util.Calendar representing the starting time for the time range
    rangeEndingCalendar - a java.util.Calendar representing the ending time for the time range
 public DailyCalendar(Calendar baseCalendar,
    long rangeStartingTimeInMillis,
    long rangeEndingTimeInMillis) 
    Create a DailyCalendar with a time range defined by the specified values and the specified baseCalendar. The values are subject to the following considerations:
    • Only the time-of-day portion of the specified values will be used
    • The starting time must be before the ending time of the defined time range. Note this means that a time range may not cross daily boundaries (10PM - 2AM). (because only time value are are used, it is possible for the two values to represent a valid time range and rangeStartingTime > rangeEndingTime)

    Note: This DailyCalendar will use the TimeZone#getDefault() time zone unless an explicit time zone is set via BaseCalendar#setTimeZone(TimeZone) . You should use #DailyCalendar(String, Calendar, TimeZone, long, long) if you don't want the given rangeStartingTimeInMillis and rangeEndingTimeInMillis to be evaluated in the default time zone.

    Parameters:
    baseCalendar - the base calendar for this calendar instance – see BaseCalendar for more information on base calendar functionality
    rangeStartingTimeInMillis - a long representing the starting time for the time range
    rangeEndingTimeInMillis - a long representing the ending time for the time range
 public DailyCalendar(TimeZone timeZone,
    long rangeStartingTimeInMillis,
    long rangeEndingTimeInMillis) 
    Create a DailyCalendar with a time range defined by the specified values and no baseCalendar. The values are subject to the following considerations:
    • Only the time-of-day portion of the specified values will be used
    • The starting time must be before the ending time of the defined time range. Note this means that a time range may not cross daily boundaries (10PM - 2AM). (because only time value are are used, it is possible for the two values to represent a valid time range and rangeStartingTime > rangeEndingTime)
    Parameters:
    timeZone - the time zone for of the DailyCalendar which will also be used to resolve the given start/end times.
    rangeStartingTimeInMillis - a long representing the starting time for the time range
    rangeEndingTimeInMillis - a long representing the ending time for the time range
 public DailyCalendar(String name,
    String rangeStartingTime,
    String rangeEndingTime) 
    Also see:
    DailyCalendar#DailyCalendar(String, String)
 public DailyCalendar(String name,
    Calendar rangeStartingCalendar,
    Calendar rangeEndingCalendar) 
    Also see:
    DailyCalendar#DailyCalendar(Calendar, Calendar)
 public DailyCalendar(String name,
    long rangeStartingTimeInMillis,
    long rangeEndingTimeInMillis) 
    Also see:
    DailyCalendar#DailyCalendar(long, long)
 public DailyCalendar(Calendar baseCalendar,
    TimeZone timeZone,
    long rangeStartingTimeInMillis,
    long rangeEndingTimeInMillis) 
    Create a DailyCalendar with a time range defined by the specified values and the specified baseCalendar. The values are subject to the following considerations:
    • Only the time-of-day portion of the specified values will be used
    • The starting time must be before the ending time of the defined time range. Note this means that a time range may not cross daily boundaries (10PM - 2AM). (because only time value are are used, it is possible for the two values to represent a valid time range and rangeStartingTime > rangeEndingTime)
    Parameters:
    baseCalendar - the base calendar for this calendar instance – see BaseCalendar for more information on base calendar functionality
    timeZone - the time zone for of the DailyCalendar which will also be used to resolve the given start/end times.
    rangeStartingTimeInMillis - a long representing the starting time for the time range
    rangeEndingTimeInMillis - a long representing the ending time for the time range
 public DailyCalendar(String name,
    Calendar baseCalendar,
    String rangeStartingTime,
    String rangeEndingTime) 
    Also see:
    DailyCalendar#DailyCalendar(org.quartz.Calendar, String, String)
 public DailyCalendar(String name,
    Calendar baseCalendar,
    Calendar rangeStartingCalendar,
    Calendar rangeEndingCalendar) 
    Also see:
    DailyCalendar#DailyCalendar(org.quartz.Calendar, Calendar, Calendar)
 public DailyCalendar(String name,
    Calendar baseCalendar,
    long rangeStartingTimeInMillis,
    long rangeEndingTimeInMillis) 
    Also see:
    DailyCalendar#DailyCalendar(org.quartz.Calendar, long, long)
 public DailyCalendar(String name,
    TimeZone timeZone,
    long rangeStartingTimeInMillis,
    long rangeEndingTimeInMillis) 
    Also see:
    DailyCalendar#DailyCalendar(TimeZone, long, long)
 public DailyCalendar(String name,
    Calendar baseCalendar,
    TimeZone timeZone,
    long rangeStartingTimeInMillis,
    long rangeEndingTimeInMillis) 
    Also see:
    DailyCalendar#DailyCalendar(org.quartz.Calendar, TimeZone, long, long)
 public DailyCalendar(int rangeStartingHourOfDay,
    int rangeStartingMinute,
    int rangeStartingSecond,
    int rangeStartingMillis,
    int rangeEndingHourOfDay,
    int rangeEndingMinute,
    int rangeEndingSecond,
    int rangeEndingMillis) 
    Parameters:
    rangeStartingHourOfDay - the hour of the start of the time range
    rangeStartingMinute - the minute of the start of the time range
    rangeStartingSecond - the second of the start of the time range
    rangeStartingMillis - the millisecond of the start of the time range
    rangeEndingHourOfDay - the hour of the end of the time range
    rangeEndingMinute - the minute of the end of the time range
    rangeEndingSecond - the second of the end of the time range
    rangeEndingMillis - the millisecond of the start of the time range
 public DailyCalendar(Calendar baseCalendar,
    int rangeStartingHourOfDay,
    int rangeStartingMinute,
    int rangeStartingSecond,
    int rangeStartingMillis,
    int rangeEndingHourOfDay,
    int rangeEndingMinute,
    int rangeEndingSecond,
    int rangeEndingMillis) 
    Create a DailyCalendar with a time range defined by the specified values and the specified baseCalendar. Values are subject to the following validations:
    • Hours must be in the range 0-23 and are expressed using military (24-hour) time.
    • Minutes must be in the range 0-59
    • Seconds must be in the range 0-59
    • Milliseconds must be in the range 0-999
    • The time range starting time must be before the time range ending time. Note this means that a time range may not cross daily boundaries (10PM - 2AM)

    Note: This DailyCalendar will use the TimeZone#getDefault() time zone unless an explicit time zone is set via BaseCalendar#setTimeZone(TimeZone)

    Parameters:
    baseCalendar - the base calendar for this calendar instance – see BaseCalendar for more information on base calendar functionality
    rangeStartingHourOfDay - the hour of the start of the time range
    rangeStartingMinute - the minute of the start of the time range
    rangeStartingSecond - the second of the start of the time range
    rangeStartingMillis - the millisecond of the start of the time range
    rangeEndingHourOfDay - the hour of the end of the time range
    rangeEndingMinute - the minute of the end of the time range
    rangeEndingSecond - the second of the end of the time range
    rangeEndingMillis - the millisecond of the start of the time range
 public DailyCalendar(String name,
    int rangeStartingHourOfDay,
    int rangeStartingMinute,
    int rangeStartingSecond,
    int rangeStartingMillis,
    int rangeEndingHourOfDay,
    int rangeEndingMinute,
    int rangeEndingSecond,
    int rangeEndingMillis) 
    Also see:
    DailyCalendar#DailyCalendar(int, int, int, int, int, int, int, int)
 public DailyCalendar(String name,
    Calendar baseCalendar,
    int rangeStartingHourOfDay,
    int rangeStartingMinute,
    int rangeStartingSecond,
    int rangeStartingMillis,
    int rangeEndingHourOfDay,
    int rangeEndingMinute,
    int rangeEndingSecond,
    int rangeEndingMillis) 
    Also see:
    DailyCalendar#DailyCalendar(org.quartz.Calendar, int, int, int, int, int, int, int, int)
Method from org.quartz.impl.calendar.DailyCalendar Summary:
getInvertTimeRange,   getName,   getNextIncludedTime,   getTimeRangeEndingTimeInMillis,   getTimeRangeStartingTimeInMillis,   isTimeIncluded,   setInvertTimeRange,   toString
Methods from org.quartz.impl.calendar.BaseCalendar:
buildHoliday,   buildHoliday,   createJavaCalendar,   createJavaCalendar,   getBaseCalendar,   getDescription,   getEndOfDayJavaCalendar,   getJavaCalendar,   getNextIncludedTime,   getStartOfDayJavaCalendar,   getTimeZone,   isTimeIncluded,   setBaseCalendar,   setDescription,   setTimeZone
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.quartz.impl.calendar.DailyCalendar Detail:
 public boolean getInvertTimeRange() 
    Indicates whether the time range represents an inverted time range (see class description).
 public String getName() 
Deprecated! The - use of name is no longer supported.

    Returns the name of the DailyCalendar
 public long getNextIncludedTime(long timeInMillis) 
    Determines the next time included by the DailyCalendar after the specified time.
 public long getTimeRangeEndingTimeInMillis(long timeInMillis) 
    Returns the end time of the time range (in milliseconds) of the day specified in timeInMillis
 public long getTimeRangeStartingTimeInMillis(long timeInMillis) 
    Returns the start time of the time range (in milliseconds) of the day specified in timeInMillis
 public boolean isTimeIncluded(long timeInMillis) 
    Determines whether the given time (in milliseconds) is 'included' by the BaseCalendar
 public  void setInvertTimeRange(boolean flag) 
    Indicates whether the time range represents an inverted time range (see class description).
 public String toString() 
    Returns a string representing the properties of the DailyCalendar