org.jboss.seam.cron.api.scheduling
Class ScheduledLiteral

java.lang.Object
  extended by javax.enterprise.util.AnnotationLiteral<Scheduled>
      extended by org.jboss.seam.cron.api.scheduling.ScheduledLiteral
All Implemented Interfaces:
Serializable, Annotation, Scheduled

public class ScheduledLiteral
extends AnnotationLiteral<Scheduled>
implements Scheduled

Author:
Peter Royle
See Also:
Serialized Form

Constructor Summary
ScheduledLiteral()
          Create a new instance of ScheduledLiteral with a default 'value'.
ScheduledLiteral(String value)
          Create a new instance of ScheduledLiteral using the given value as the schedule specification/name.
 
Method Summary
 String value()
          The schedule specification (in cron format) or name.
 
Methods inherited from class javax.enterprise.util.AnnotationLiteral
annotationType, equals, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.lang.annotation.Annotation
annotationType, equals, hashCode, toString
 

Constructor Detail

ScheduledLiteral

public ScheduledLiteral()
Create a new instance of ScheduledLiteral with a default 'value'. Note that this defaulted 'value' is an invalid schedule/name and will cause errors during setting up of the schedules if used.


ScheduledLiteral

public ScheduledLiteral(String value)
Create a new instance of ScheduledLiteral using the given value as the schedule specification/name.

Parameters:
value - The value to be used as the schedule specification/name.
Method Detail

value

public String value()
The schedule specification (in cron format) or name. If the value is a name, then the cron-formatted schedule specification will be read from the /cron.properties file on the classpath using the name as the property key.

Returns:
the value.


Copyright © 2011 Seam Framework. All Rights Reserved.