giacomo 2003/09/05 03:20:21
Modified: src/blocks/cron/java/org/apache/cocoon/components/cron
JobScheduler.java
Log:
polished javadocs and pretty printed
Revision Changes Path
1.5 +39 -40
cocoon-2.1/src/blocks/cron/java/org/apache/cocoon/components/cron/JobScheduler.java
Index: JobScheduler.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/cron/java/org/apache/cocoon/components/cron/JobScheduler.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -b -u -r1.4 -r1.5
--- JobScheduler.java 4 Sep 2003 15:59:09 -0000 1.4
+++ JobScheduler.java 5 Sep 2003 10:20:21 -0000 1.5
@@ -85,27 +85,7 @@
JobSchedulerEntry getJobSchedulerEntry(String jobname);
/**
- * Schedule a periodic job.
- * The job is started the first time when the period has passed.
- * Note that if a Job already has same name then it is overwritten.
- *
- * @param name the name of the job
- * @param jobrole The Avalon components role name of the job itself
- * @param period Every period seconds this job is started
- * @param canRunConcurrently whether this job can run even previous
scheduled runs are still running
- * @param params Additional Parameters to setup CronJob
- * @param objects A Map with additional object to setup CronJob
- */
- void addPeriodicJob(String name,
- String jobrole,
- long period,
- boolean canRunConcurrently,
- Parameters params,
- Map objects)
- throws CascadingException;
-
- /**
- * Schedule a time based job. Note that if a CronJob already has same
name then it is overwritten.
+ * Schedule a time based job. Note that if a job with the same name has
already beed added it is overwritten.
*
* @param name the name of the job
* @param jobrole The Avalon components role name of the job itself
@@ -116,7 +96,7 @@
throws CascadingException;
/**
- * Schedule a time based job. Note that if a CronJob already has same
name then it is overwritten.
+ * Schedule a time based job. Note that if a job with the same name has
already beed added it is overwritten.
*
* @param name the name of the job
* @param jobrole The Avalon components role name of the job itself
@@ -129,7 +109,7 @@
throws CascadingException;
/**
- * Schedule a job. Note that if a CronJob already has the same name then
it is overwritten.
+ * Schedule a time based job. Note that if a job with the same name has
already beed added it is overwritten.
*
* @param name the name of the job
* @param job The job object itself. It must implement either CronJob,
Runnable or might also be an implementation
@@ -141,7 +121,7 @@
throws CascadingException;
/**
- * Schedule a job. Note that if a CronJob already has the same name then
it is overwritten.
+ * Schedule a job. Note that if a job with the same name has already
beed added it is overwritten.
*
* @param name the name of the job
* @param job The job object itself. It must implement either CronJob,
Runnable or might also be an implementation
@@ -155,6 +135,21 @@
throws CascadingException;
/**
+ * Schedule a periodic job. The job is started the first time when the
period has passed. Note that if a job with
+ * the same name has already beed added it is overwritten.
+ *
+ * @param name the name of the job
+ * @param jobrole The Avalon components role name of the job itself
+ * @param period Every period seconds this job is started
+ * @param canRunConcurrently whether this job can run even previous
scheduled runs are still running
+ * @param params Additional Parameters to setup CronJob
+ * @param objects A Map with additional object to setup CronJob
+ */
+ void addPeriodicJob(String name, String jobrole, long period, boolean
canRunConcurrently, Parameters params,
+ Map objects)
+ throws CascadingException;
+
+ /**
* Fire a job once immediately
*
* @param jobrole The Avalon components role name of the job itself
@@ -199,7 +194,8 @@
throws CascadingException;
/**
- * Fire a job once at a specific date
+ * Fire a job once at a specific date Note that if a job with the same
name has already beed added it is
+ * overwritten.
*
* @param date The date this job should be scheduled
* @param name the name of the job
@@ -209,7 +205,8 @@
throws CascadingException;
/**
- * Fire a job once immediately
+ * Fire a job once at a specific date Note that if a job with the same
name has already beed added it is
+ * overwritten.
*
* @param date The date this job should be scheduled
* @param name the name of the job
@@ -221,7 +218,8 @@
throws CascadingException;
/**
- * Fire a CronJob once immediately
+ * Fire a job once at a specific date Note that if a job with the same
name has already beed added it is
+ * overwritten.
*
* @param date The date this job should be scheduled
* @param name the name of the job
@@ -232,7 +230,8 @@
throws CascadingException;
/**
- * Fire a job once immediately
+ * Fire a job once at a specific date Note that if a job with the same
name has already beed added it is
+ * overwritten.
*
* @param date The date this job should be scheduled
* @param name the name of the job
