Home » quartz-1.6.0 » org » quartz » [javadoc | source]
org.quartz
public class: TriggerUtils [javadoc | source]
java.lang.Object
   org.quartz.TriggerUtils

Convenience and utility methods for simplifying the construction and configuration of Trigger s.

Please submit suggestions for additional convenience methods to either the Quartz user forum or the developer's mail list at source forge.

Field Summary
public static final  int SUNDAY     
public static final  int MONDAY     
public static final  int TUESDAY     
public static final  int WEDNESDAY     
public static final  int THURSDAY     
public static final  int FRIDAY     
public static final  int SATURDAY     
public static final  int LAST_DAY_OF_MONTH     
public static final  long MILLISECONDS_IN_MINUTE     
public static final  long MILLISECONDS_IN_HOUR     
public static final  long SECONDS_IN_DAY     
public static final  long MILLISECONDS_IN_DAY     
Method from org.quartz.TriggerUtils Summary:
computeFireTimes,   computeFireTimesBetween,   getDSTSavings,   getDateOf,   getDateOf,   getDateOf,   getEvenHourDate,   getEvenHourDateBefore,   getEvenMinuteDate,   getEvenMinuteDateBefore,   getEvenSecondDate,   getEvenSecondDateBefore,   getNextGivenMinuteDate,   getNextGivenSecondDate,   getOffset,   makeDailyTrigger,   makeDailyTrigger,   makeHourlyTrigger,   makeHourlyTrigger,   makeHourlyTrigger,   makeHourlyTrigger,   makeHourlyTrigger,   makeImmediateTrigger,   makeImmediateTrigger,   makeMinutelyTrigger,   makeMinutelyTrigger,   makeMinutelyTrigger,   makeMinutelyTrigger,   makeMinutelyTrigger,   makeMonthlyTrigger,   makeMonthlyTrigger,   makeSecondlyTrigger,   makeSecondlyTrigger,   makeSecondlyTrigger,   makeSecondlyTrigger,   makeSecondlyTrigger,   makeWeeklyTrigger,   makeWeeklyTrigger,   setTriggerIdentity,   setTriggerIdentity,   translateTime
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.quartz.TriggerUtils Detail:
 public static List computeFireTimes(Trigger trigg,
    Calendar cal,
    int numTimes) 
    Returns a list of Dates that are the next fire times of a Trigger. The input trigger will be cloned before any work is done, so you need not worry about its state being altered by this method.
 public static List computeFireTimesBetween(Trigger trigg,
    Calendar cal,
    Date from,
    Date to) 
    Returns a list of Dates that are the next fire times of a Trigger that fall within the given date range. The input trigger will be cloned before any work is done, so you need not worry about its state being altered by this method.

    NOTE: if this is a trigger that has previously fired within the given date range, then firings which have already occured will not be listed in the output List.

 public static int getDSTSavings(TimeZone tz) 

    Equivalent of TimeZone.getDSTSavings() in JDK 1.4, but Quartz is trying to support JDK 1.3.

 public static Date getDateOf(int second,
    int minute,
    int hour) 

    Get a Date object that represents the given time, on today's date.

 public static Date getDateOf(int second,
    int minute,
    int hour,
    int dayOfMonth,
    int month) 

    Get a Date object that represents the given time, on the given date.

 public static Date getDateOf(int second,
    int minute,
    int hour,
    int dayOfMonth,
    int month,
    int year) 

    Get a Date object that represents the given time, on the given date.

 public static Date getEvenHourDate(Date date) 

    Returns a date that is rounded to the next even hour above the given date.

    For example an input date with a time of 08:13:54 would result in a date with the time of 09:00:00. If the date's time is in the 23rd hour, the date's 'day' will be promoted, and the time will be set to 00:00:00.

 public static Date getEvenHourDateBefore(Date date) 

    Returns a date that is rounded to the previous even hour below the given date.

    For example an input date with a time of 08:13:54 would result in a date with the time of 08:00:00.

 public static Date getEvenMinuteDate(Date date) 

    Returns a date that is rounded to the next even minute above the given date.

    For example an input date with a time of 08:13:54 would result in a date with the time of 08:14:00. If the date's time is in the 59th minute, then the hour (and possibly the day) will be promoted.

 public static Date getEvenMinuteDateBefore(Date date) 

    Returns a date that is rounded to the previous even minute below the given date.

    For example an input date with a time of 08:13:54 would result in a date with the time of 08:13:00.

 public static Date getEvenSecondDate(Date date) 

    Returns a date that is rounded to the next even second above the given date.

 public static Date getEvenSecondDateBefore(Date date) 

    Returns a date that is rounded to the previous even second below the given date.

    For example an input date with a time of 08:13:54.341 would result in a date with the time of 08:13:00.000.

 public static Date getNextGivenMinuteDate(Date date,
    int minuteBase) 

    Returns a date that is rounded to the next even multiple of the given minute.

    For example an input date with a time of 08:13:54, and an input minute-base of 5 would result in a date with the time of 08:15:00. The same input date with an input minute-base of 10 would result in a date with the time of 08:20:00. But a date with the time 08:53:31 and an input minute-base of 45 would result in 09:00:00, because the even-hour is the next 'base' for 45-minute intervals.

    More examples:
    Input Time Minute-Base Result Time
    11:16:41 20 11:20:00
    11:36:41 20 11:40:00
    11:46:41 20 12:00:00
    11:26:41 30 11:30:00
    11:36:41 30 12:00:00
    11:16:41 17 11:17:00
    11:17:41 17 11:34:00
    11:52:41 17 12:00:00
    11:52:41 5 11:55:00
    11:57:41 5 12:00:00
    11:17:41 0 12:00:00
    11:17:41 1 11:08:00

 public static Date getNextGivenSecondDate(Date date,
    int secondBase) 

    Returns a date that is rounded to the next even multiple of the given minute.

    The rules for calculating the second are the same as those for calculating the minute in the method getNextGivenMinuteDate(..).

 public static int getOffset(long date,
    TimeZone tz) 
    Gets the offset from UT for the given date in the given timezone, taking into account daylight savings.

    Equivalent of TimeZone.getOffset(date) in JDK 1.4, but Quartz is trying to support JDK 1.3.

 public static Trigger makeDailyTrigger(int hour,
    int minute) 

    Make a trigger that will fire every day at the given time.

    The generated trigger will not have its name, group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeDailyTrigger(String trigName,
    int hour,
    int minute) 

    Make a trigger that will fire every day at the given time.

    The generated trigger will not have its group or end-time set. The Start time defaults to 'now'.

 public static Trigger makeHourlyTrigger() 

    Make a trigger that will fire every hour, indefinitely.

    The generated trigger will not have its name, group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeHourlyTrigger(String trigName) 

    Make a trigger that will fire every hour, indefinitely.

    The generated trigger will not have its group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeHourlyTrigger(int intervalInHours) 

    Make a trigger that will fire every N hours, indefinitely.

    The generated trigger will not have its name, group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeHourlyTrigger(int intervalInHours,
    int repeatCount) 

    Make a trigger that will fire every N hours, with the given number of repeats.

    The generated trigger will not have its name, group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeHourlyTrigger(String trigName,
    int intervalInHours,
    int repeatCount) 

    Make a trigger that will fire every N hours, with the given number of repeats.

    The generated trigger will not have its group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeImmediateTrigger(int repeatCount,
    long repeatInterval) 

    Make a trigger that will fire repeatCount times, waiting repeatInterval milliseconds between each fire.

    The generated trigger will not have its name, group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeImmediateTrigger(String trigName,
    int repeatCount,
    long repeatInterval) 

    Make a trigger that will fire repeatCount times, waiting repeatInterval milliseconds between each fire.

    The generated trigger will not have its name, group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeMinutelyTrigger() 

    Make a trigger that will fire every minute, indefinitely.

    The generated trigger will not have its name, group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeMinutelyTrigger(String trigName) 

    Make a trigger that will fire every minute, indefinitely.

    The generated trigger will not have its group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeMinutelyTrigger(int intervalInMinutes) 

    Make a trigger that will fire every N minutes, indefinitely.

    The generated trigger will not have its name, group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeMinutelyTrigger(int intervalInMinutes,
    int repeatCount) 

    Make a trigger that will fire every N minutes, with the given number of repeats.

    The generated trigger will not have its name, group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeMinutelyTrigger(String trigName,
    int intervalInMinutes,
    int repeatCount) 

    Make a trigger that will fire every N minutes, with the given number of repeats.

    The generated trigger will not have its group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeMonthlyTrigger(int dayOfMonth,
    int hour,
    int minute) 

    Make a trigger that will fire every month at the given day and time.

    The generated trigger will not have its name, group, or end-time set. The Start time defaults to 'now'.

    If the day of the month specified does not occur in a given month, a firing will not occur that month. (i.e. if dayOfMonth is specified as 31, no firing will occur in the months of the year with fewer than 31 days).

 public static Trigger makeMonthlyTrigger(String trigName,
    int dayOfMonth,
    int hour,
    int minute) 

    Make a trigger that will fire every month at the given day and time.

    The generated trigger will not have its group, or end-time set. The Start time defaults to 'now'.

    If the day of the month specified does not occur in a given month, a firing will not occur that month. (i.e. if dayOfMonth is specified as 31, no firing will occur in the months of the year with fewer than 31 days).

 public static Trigger makeSecondlyTrigger() 

    Make a trigger that will fire every second, indefinitely.

    The generated trigger will not have its name, group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeSecondlyTrigger(String trigName) 

    Make a trigger that will fire every second, indefinitely.

    The generated trigger will not have its group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeSecondlyTrigger(int intervalInSeconds) 

    Make a trigger that will fire every N seconds, indefinitely.

    The generated trigger will not have its name, group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeSecondlyTrigger(int intervalInSeconds,
    int repeatCount) 

    Make a trigger that will fire every N seconds, with the given number of repeats.

    The generated trigger will not have its name, group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeSecondlyTrigger(String trigName,
    int intervalInSeconds,
    int repeatCount) 

    Make a trigger that will fire every N seconds, with the given number of repeats.

    The generated trigger will not have its group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeWeeklyTrigger(int dayOfWeek,
    int hour,
    int minute) 

    Make a trigger that will fire every week at the given day and time.

    The generated trigger will not have its name, group, or end-time set. The Start time defaults to 'now'.

 public static Trigger makeWeeklyTrigger(String trigName,
    int dayOfWeek,
    int hour,
    int minute) 

    Make a trigger that will fire every week at the given day and time.

    The generated trigger will not have its group, or end-time set. The Start time defaults to 'now'.

 public static  void setTriggerIdentity(Trigger trig,
    String name) 

    Set the given Trigger's name to the given value, and its group to the default group (Scheduler.DEFAULT_GROUP).

 public static  void setTriggerIdentity(Trigger trig,
    String name,
    String group) 

    Set the given Trigger's name to the given value, and its group to the given group.

 public static Date translateTime(Date date,
    TimeZone src,
    TimeZone dest) 
    Translate a date & time from a users timezone to the another (probably server) timezone to assist in creating a simple trigger with the right date & time.