org.beanlet
Annotation Type Schedule


@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface Schedule

Methods declared with this annotation are scheduled to be executed by a background thread.

Method Constraints

The method on which the Schedule annotation is applied MUST fulfill all of the following criteria:

XML Representation

The following xml-fragment shows how to express this annotation in xml. The italic attribute of the 'schedule' tag is used to identify the element to which this annotation is applied. The other attributes can be specified optionally if the annotation specifies a default value for the particular annotation methods.
<beanlets xmlns="http://beanlet.org/schema/beanlet"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://beanlet.org/schema/beanlet http://beanlet.org/schema/beanlet/beanlet_1_0.xsd">
  <beanlet name="foo" type="com.acme.Foo">
    <schedule method="bar" once="false" interrupt="false"
              join="false" initial-delay="0" delay="0"
              rate="0" cron="" fire-all="false"
              description=""/>
  </beanlet>
</beanlets>


Optional Element Summary
 String cron
          Provides a parser and evaluator for unix-like cron expressions.
 long delay
          Set to a positive long value to let the container execute the runnable method with a fixed delay interval.
 String description
          Description of the underlying schedulable method.
 boolean fireAll
          Set to true if schedule must be performed even in case of misfire.
 long initialDelay
          Set to a positive long value to let the container wait for an initial delay before executing the runnable method for the first time.
 boolean interrupt
          If true, the running threads are interrupted on destroy.
 boolean join
          If true, the container waits until this component has finished the runnable method on destroy.
 boolean once
          If true, the method is scheduled only once.
 long rate
          Set to a positive long value to let the container execute the runnable method with a fixed rate interval.
 

once

public abstract boolean once
If true, the method is scheduled only once.

Default:
false

interrupt

public abstract boolean interrupt
If true, the running threads are interrupted on destroy.

Default:
false

join

public abstract boolean join
If true, the container waits until this component has finished the runnable method on destroy.

Default:
false

initialDelay

public abstract long initialDelay
Set to a positive long value to let the container wait for an initial delay before executing the runnable method for the first time.

Default:
0L

delay

public abstract long delay
Set to a positive long value to let the container execute the runnable method with a fixed delay interval.

Default:
0L

rate

public abstract long rate
Set to a positive long value to let the container execute the runnable method with a fixed rate interval.

Default:
0L

cron

public abstract String cron

Provides a parser and evaluator for unix-like cron expressions. Cron expressions provide the ability to specify complex time combinations such as "At 8:00am every Monday through Friday" or "At 1:30am every last Friday of the month".

Cron expressions are comprised of 6 required fields and two optional fields separated by white space. The fields respectively are described as follows:

Field Name   Allowed Values   Allowed Special Characters
Seconds   0-59   , - * /
Minutes   0-59   , - * /
Hours   0-23   , - * /
Day-of-month   1-31   , - * ? / L W
Month   1-12 or JAN-DEC   , - * /
Day-of-Week   1-7 or SUN-SAT   , - * ? / L #
Year (Optional)   empty, 1970-2099   , - * /
TimeZone (Optional)   empty, Europe/Amsterdam   *

The '*' character is used to specify all values. For example, "*" in the minute field means "every minute".

The '?' character is allowed for the day-of-month and day-of-week fields. It is used to specify 'no specific value'. This is useful when you need to specify something in one of the two fileds, but not the other.

The '-' character is used to specify ranges For example "10-12" in the hour field means "the hours 10, 11 and 12".

The ',' character is used to specify additional values. For example "MON,WED,FRI" in the day-of-week field means "the days Monday, Wednesday, and Friday".

The '/' character is used to specify increments. For example "0/15" in the seconds field means "the seconds 0, 15, 30, and 45". And "5/15" in the seconds field means "the seconds 5, 20, 35, and 50". Specifying '*' before the '/' is equivalent to specifying 0 is the value to start with. Essentially, for each field in the expression, there is a set of numbers that can be turned on or off. For seconds and minutes, the numbers range from 0 to 59. For hours 0 to 23, for days of the month 0 to 31, and for months 1 to 12. The "/" character simply helps you turn on every "nth" value in the given set. Thus "7/6" in the month field only turns on month "7", it does NOT mean every 6th month, please note that subtlety.

The 'L' character is allowed for the day-of-month and day-of-week fields. This character is short-hand for "last", but it has different meaning in each of the two fields. For example, the value "L" in the day-of-month field means "the last day of the month" - day 31 for January, day 28 for February on non-leap years. If used in the day-of-week field by itself, it simply means "7" or "SAT". But if used in the day-of-week field after another value, it means "the last xxx day of the month" - for example "6L" means "the last friday of the month". When using the 'L' option, it is important not to specify lists, or ranges of values, as you'll get confusing results.

The 'W' character is allowed for the day-of-month field. This character is used to specify the weekday (Monday-Friday) nearest the given day. As an example, if you were to specify "15W" as the value for the day-of-month field, the meaning is: "the nearest weekday to the 15th of the month". So if the 15th is a Saturday, the trigger will fire on Friday the 14th. If the 15th is a Sunday, the trigger will fire on Monday the 16th. If the 15th is a Tuesday, then it will fire on Tuesday the 15th. However if you specify "1W" as the value for day-of-month, and the 1st is a Saturday, the trigger will fire on Monday the 3rd, as it will not 'jump' over the boundary of a month's days. The 'W' character can only be specified when the day-of-month is a single day, not a range or list of days.

The 'L' and 'W' characters can also be combined for the day-of-month expression to yield 'LW', which translates to "last weekday of the month".

The '#' character is allowed for the day-of-week field. This character is used to specify "the nth" XXX day of the month. For example, the value of "6#3" in the day-of-week field means the third Friday of the month (day 6 = Friday and "#3" = the 3rd one in the month). Other examples: "2#1" = the first Monday of the month and "4#5" = the fifth Wednesday of the month. Note that if you specify "#5" and there is not 5 of the given day-of-week in the month, then no firing will occur that month.

The legal characters and the names of months and days of the week are not case sensitive.

NOTES:

Default:
""

fireAll

public abstract boolean fireAll
Set to true if schedule must be performed even in case of misfire.

Default:
false

description

public abstract String description
Description of the underlying schedulable method.

Default:
""


Copyright © 2006-2012. All Rights Reserved.