{"doc":" Provides a parser and evaluator for unix-like cron expressions. Cron\n expressions provide the ability to specify complex time combinations such as\n "At 8:00am every Monday through Friday" or "At 1:30am every\n last Friday of the month".\n <P>\n Cron expressions are comprised of 6 required fields and one optional field\n separated by white space. The fields respectively are described as follows:\n\n <table cellspacing=\"8\">\n <tr>\n <th align=\"left\">Field Name</th>\n <th align=\"left\"> </th>\n <th align=\"left\">Allowed Values</th>\n <th align=\"left\"> </th>\n <th align=\"left\">Allowed Special Characters</th>\n </tr>\n <tr>\n <td align=\"left\"><code>Seconds</code></td>\n <td align=\"left\"> </th>\n <td align=\"left\"><code>0-59</code></td>\n <td align=\"left\"> </th>\n <td align=\"left\"><code>, - * /</code></td>\n </tr>\n <tr>\n <td align=\"left\"><code>Minutes</code></td>\n <td align=\"left\"> </th>\n <td align=\"left\"><code>0-59</code></td>\n <td align=\"left\"> </th>\n <td align=\"left\"><code>, - * /</code></td>\n </tr>\n <tr>\n <td align=\"left\"><code>Hours</code></td>\n <td align=\"left\"> </th>\n <td align=\"left\"><code>0-23</code></td>\n <td align=\"left\"> </th>\n <td align=\"left\"><code>, - * /</code></td>\n </tr>\n <tr>\n <td align=\"left\"><code>Day-of-month</code></td>\n <td align=\"left\"> </th>\n <td align=\"left\"><code>1-31</code></td>\n <td align=\"left\"> </th>\n <td align=\"left\"><code>, - * ? / L W</code></td>\n </tr>\n <tr>\n <td align=\"left\"><code>Month</code></td>\n <td align=\"left\"> </th>\n <td align=\"left\"><code>0-11 or JAN-DEC</code></td>\n <td align=\"left\"> </th>\n <td align=\"left\"><code>, - * /</code></td>\n </tr>\n <tr>\n <td align=\"left\"><code>Day-of-Week</code></td>\n <td align=\"left\"> </th>\n <td align=\"left\"><code>1-7 or SUN-SAT</code></td>\n <td align=\"left\"> </th>\n <td align=\"left\"><code>, - * ? / L #</code></td>\n </tr>\n <tr>\n <td align=\"left\"><code>Year (Optional)</code></td>\n <td align=\"left\"> </th>\n <td align=\"left\"><code>empty, 1970-2199</code></td>\n <td align=\"left\"> </th>\n <td align=\"left\"><code>, - * /</code></td>\n </tr>\n </table>\n <P>\n The '*' character is used to specify all values. For example, "*"\n in the minute field means "every minute".\n <P>\n The '?' character is allowed for the day-of-month and day-of-week fields. It\n is used to specify 'no specific value'. This is useful when you need to\n specify something in one of the two fields, but not the other.\n <P>\n The '-' character is used to specify ranges For example "10-12" in\n the hour field means "the hours 10, 11 and 12".\n <P>\n The ',' character is used to specify additional values. For example\n "MON,WED,FRI" in the day-of-week field means "the days Monday,\n Wednesday, and Friday".\n <P>\n The '/' character is used to specify increments. For example "0/15"\n in the seconds field means "the seconds 0, 15, 30, and 45". And\n "5/15" in the seconds field means "the seconds 5, 20, 35, and\n 50". Specifying '*' before the '/' is equivalent to specifying 0 is\n the value to start with. Essentially, for each field in the expression, there\n is a set of numbers that can be turned on or off. For seconds and minutes,\n the numbers range from 0 to 59. For hours 0 to 23, for days of the month 0 to\n 31, and for months 0 to 11 (JAN to DEC). The "/" character simply helps you turn\n on every "nth" value in the given set. Thus "7/6" in the\n month field only turns on month "7", it does NOT mean every 6th\n month, please note that subtlety.\n <P>\n The 'L' character is allowed for the day-of-month and day-of-week fields.\n This character is short-hand for "last", but it has different\n meaning in each of the two fields. For example, the value "L" in\n the day-of-month field means "the last day of the month" - day 31\n for January, day 28 for February on non-leap years. If used in the\n day-of-week field by itself, it simply means "7" or\n "SAT". But if used in the day-of-week field after another value, it\n means "the last xxx day of the month" - for example "6L"\n means "the last friday of the month". You can also specify an offset\n from the last day of the month, such as \"L-3\" which would mean the third-to-last\n day of the calendar month. <i>When using the 'L' option, it is important not to\n specify lists, or ranges of values, as you'll get confusing/unexpected results.</i>\n <P>\n The 'W' character is allowed for the day-of-month field. This character\n is used to specify the weekday (Monday-Friday) nearest the given day. As an\n example, if you were to specify "15W" as the value for the\n day-of-month field, the meaning is: "the nearest weekday to the 15th of\n the month". So if the 15th is a Saturday, the trigger will fire on\n Friday the 14th. If the 15th is a Sunday, the trigger will fire on Monday the\n 16th. If the 15th is a Tuesday, then it will fire on Tuesday the 15th.\n However if you specify "1W" as the value for day-of-month, and the\n 1st is a Saturday, the trigger will fire on Monday the 3rd, as it will not\n 'jump' over the boundary of a month's days. The 'W' character can only be\n specified when the day-of-month is a single day, not a range or list of days.\n <P>\n The 'L' and 'W' characters can also be combined for the day-of-month\n expression to yield 'LW', which translates to "last weekday of the\n month".\n <P>\n The '#' character is allowed for the day-of-week field. This character is\n used to specify "the nth" XXX day of the month. For example, the\n value of "6#3" in the day-of-week field means the third Friday of\n the month (day 6 = Friday and "#3" = the 3rd one in the month).\n Other examples: "2#1" = the first Monday of the month and\n "4#5" = the fifth Wednesday of the month. Note that if you specify\n "#5" and there is not 5 of the given day-of-week in the month, then\n no firing will occur that month. If the '#' character is used, there can\n only be one expression in the day-of-week field ("3#1,6#3" is\n not valid, since there are two expressions).\n <P>\n <!--The 'C' character is allowed for the day-of-month and day-of-week fields.\n This character is short-hand for \"calendar\". This means values are\n calculated against the associated calendar, if any. If no calendar is\n associated, then it is equivalent to having an all-inclusive calendar. A\n value of \"5C\" in the day-of-month field means \"the first day included by the\n calendar on or after the 5th\". A value of \"1C\" in the day-of-week field\n means \"the first day included by the calendar on or after Sunday\".-->\n <P>\n The legal characters and the names of months and days of the week are not\n case sensitive.\n\n <p>\n <b>NOTES:</b>\n <ul>\n <li>Support for specifying both a day-of-week and a day-of-month value is\n not complete (you'll need to use the '?' character in one of these fields).\n </li>\n <li>Overflowing ranges is supported - that is, having a larger number on\n the left hand side than the right. You might do 22-2 to catch 10 o'clock\n at night until 2 o'clock in the morning, or you might have NOV-FEB. It is\n very important to note that overuse of overflowing ranges creates ranges\n that don't make sense and no effort has been made to determine which\n interpretation CronExpression chooses. An example would be\n \"0 0 14-6 ? * FRI-MON\". </li>\n </ul>\n </p>\n\n @author Sharada Jambula, James House\n @author Contributions from Mads Henderson\n @author Refactoring from CronTrigger to CronExpression by Aaron Craven\n <p>\n Borrowed from quartz v2.3.1\n","fields":[],"enumConstants":[],"methods":[{"name":"isSatisfiedBy","paramTypes":["java.util.Date"],"doc":" Indicates whether the given date satisfies the cron expression. Note that\n milliseconds are ignored, so two Dates falling on different milliseconds\n of the same second will always have the same result here.\n\n @param date the date to evaluate\n @return a boolean indicating whether the given date satisfies the cron\n expression\n"},{"name":"getNextValidTimeAfter","paramTypes":["java.util.Date"],"doc":" Returns the next date/time <I>after</I> the given date/time which\n satisfies the cron expression.\n\n @param date the date/time at which to begin the search for the next valid\n date/time\n @return the next valid date/time\n"},{"name":"getNextInvalidTimeAfter","paramTypes":["java.util.Date"],"doc":" Returns the next date/time <I>after</I> the given date/time which does\n <I>not</I> satisfy the expression\n\n @param date the date/time at which to begin the search for the next\n invalid date/time\n @return the next valid date/time\n"},{"name":"getTimeZone","paramTypes":[],"doc":" Returns the time zone for which this <code>CronExpression</code>\n will be resolved.\n"},{"name":"setTimeZone","paramTypes":["java.util.TimeZone"],"doc":" Sets the time zone for which this <code>CronExpression</code>\n will be resolved.\n"},{"name":"toString","paramTypes":[],"doc":" Returns the string representation of the <CODE>CronExpression</CODE>\n\n @return a string representation of the <CODE>CronExpression</CODE>\n"},{"name":"isValidExpression","paramTypes":["java.lang.String"],"doc":" Indicates whether the specified cron expression can be parsed into a\n valid cron expression\n\n @param cronExpression the expression to evaluate\n @return a boolean indicating whether the given expression is a valid cron\n expression\n"},{"name":"setCalendarHour","paramTypes":["java.util.Calendar","int"],"doc":" Advance the calendar to the particular hour paying particular attention\n to daylight saving problems.\n\n @param cal the calendar to operate on\n @param hour the hour to set\n"},{"name":"getTimeBefore","paramTypes":["java.util.Date"],"doc":" NOT YET IMPLEMENTED: Returns the time before the given time\n that the <code>CronExpression</code> matches.\n"},{"name":"getFinalFireTime","paramTypes":[],"doc":" NOT YET IMPLEMENTED: Returns the final time that the\n <code>CronExpression</code> will match.\n"}],"constructors":[{"name":"<init>","paramTypes":["java.lang.String"],"doc":" Constructs a new <CODE>CronExpression</CODE> based on the specified\n parameter.\n\n @param cronExpression String representation of the cron expression the\n new object should represent\n @throws ParseException if the string expression cannot be parsed into a valid\n <CODE>CronExpression</CODE>\n"},{"name":"<init>","paramTypes":["com.xxl.job.admin.core.cron.CronExpression"],"doc":" Constructs a new {@code CronExpression} as a copy of an existing\n instance.\n\n @param expression The existing cron expression to be copied\n"}]}
|
