Author: cziegeler
Date: Fri Jul 8 05:48:31 2016
New Revision: 1751858
URL: http://svn.apache.org/viewvc?rev=1751858&view=rev
Log:
Fix javadocs
Modified:
sling/trunk/bundles/commons/scheduler/pom.xml
sling/trunk/bundles/commons/scheduler/src/main/java/org/apache/sling/commons/scheduler/ScheduleOptions.java
sling/trunk/bundles/commons/scheduler/src/main/java/org/apache/sling/commons/scheduler/Scheduler.java
Modified: sling/trunk/bundles/commons/scheduler/pom.xml
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/commons/scheduler/pom.xml?rev=1751858&r1=1751857&r2=1751858&view=diff
==============================================================================
--- sling/trunk/bundles/commons/scheduler/pom.xml (original)
+++ sling/trunk/bundles/commons/scheduler/pom.xml Fri Jul 8 05:48:31 2016
@@ -124,10 +124,6 @@
</instructions>
</configuration>
</plugin>
- </plugins>
- </build>
- <reporting>
- <plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
@@ -138,7 +134,7 @@
</configuration>
</plugin>
</plugins>
- </reporting>
+ </build>
<dependencies>
<dependency>
<groupId>org.apache.felix</groupId>
Modified:
sling/trunk/bundles/commons/scheduler/src/main/java/org/apache/sling/commons/scheduler/ScheduleOptions.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/commons/scheduler/src/main/java/org/apache/sling/commons/scheduler/ScheduleOptions.java?rev=1751858&r1=1751857&r2=1751858&view=diff
==============================================================================
---
sling/trunk/bundles/commons/scheduler/src/main/java/org/apache/sling/commons/scheduler/ScheduleOptions.java
(original)
+++
sling/trunk/bundles/commons/scheduler/src/main/java/org/apache/sling/commons/scheduler/ScheduleOptions.java
Fri Jul 8 05:48:31 2016
@@ -33,23 +33,26 @@ public interface ScheduleOptions {
/**
* Add optional configuration for the job.
* @param config An optional configuration object - this configuration is
only passed to the job the job implements {@link Job}.
+ * @return The schedule options.
*/
- ScheduleOptions config(final Map<String, Serializable> config);
+ ScheduleOptions config(Map<String, Serializable> config);
/**
* Sets the name of the job.
* A job only needs a name if it is scheduled and should be cancelled
later on. The name can then be used to cancel the job.
* If a second job with the same name is started, the second one replaces
the first one.
* @param name The job name
+ * @return The schedule options.
*/
- ScheduleOptions name(final String name);
+ ScheduleOptions name(String name);
/**
* Flag indicating whether the job can be run concurrently.
* This defaults to false.
* @param flag Whether this job can run even if previous scheduled runs
are still running.
+ * @return The schedule options.
*/
- ScheduleOptions canRunConcurrently(final boolean flag);
+ ScheduleOptions canRunConcurrently(boolean flag);
/**
* Flag indicating whether the job should only be run on the leader. This
defaults to false.
@@ -62,8 +65,9 @@ public interface ScheduleOptions {
* If {@link #onSingleInstanceOnly(boolean)} or {@link
#onInstancesOnly(String[])} has been called before,
* that option is reset and overwritten by the value of this method.
* @param flag Whether this job should only be run on the leader
+ * @return The schedule options.
*/
- ScheduleOptions onLeaderOnly(final boolean flag);
+ ScheduleOptions onLeaderOnly(boolean flag);
/**
* Flag indicating whether the job should only be run on a single instance
in a cluster
@@ -76,8 +80,9 @@ public interface ScheduleOptions {
* If {@link #onLeaderOnly(boolean)} or {@link #onInstancesOnly(String[])}
has been called before,
* that option is reset and overwritten by the value of this method.
* @param flag Whether this job should only be run on a single instance.
+ * @return The schedule options.
*/
- ScheduleOptions onSingleInstanceOnly(final boolean flag);
+ ScheduleOptions onSingleInstanceOnly(boolean flag);
/**
* List of Sling IDs this job should be run on.
@@ -87,6 +92,7 @@ public interface ScheduleOptions {
* If {@link #onLeaderOnly(boolean)} or {@link
#onSingleInstanceOnly(boolean)} has been called before,
* that option is reset and overwritten by the value of this method.
* @param slingIds Array of Sling IDs this job should run on
+ * @return The schedule options.
*/
- ScheduleOptions onInstancesOnly(final String[] slingIds);
+ ScheduleOptions onInstancesOnly(String[] slingIds);
}
Modified:
sling/trunk/bundles/commons/scheduler/src/main/java/org/apache/sling/commons/scheduler/Scheduler.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/commons/scheduler/src/main/java/org/apache/sling/commons/scheduler/Scheduler.java?rev=1751858&r1=1751857&r2=1751858&view=diff
==============================================================================
---
sling/trunk/bundles/commons/scheduler/src/main/java/org/apache/sling/commons/scheduler/Scheduler.java
(original)
+++
sling/trunk/bundles/commons/scheduler/src/main/java/org/apache/sling/commons/scheduler/Scheduler.java
Fri Jul 8 05:48:31 2016
@@ -137,7 +137,7 @@ public interface Scheduler {
/**
* Remove a scheduled job by name.
*
- * @param name The name of the job.
+ * @param jobName The name of the job.
* @return <code>true</code> if the job existed and could be stopped,
<code>false</code> otherwise.
* @since 2.3
*/
@@ -145,6 +145,7 @@ public interface Scheduler {
/**
* Create a schedule options to fire a job immediately and only once.
+ * @return The schedule options.
* @since 2.3
*/
ScheduleOptions NOW();
@@ -154,6 +155,7 @@ public interface Scheduler {
* @param times The number of times this job should be started (must be
higher than 1 or
* -1 for endless)
* @param period Every period seconds this job is started (must be at
higher than 0).
+ * @return The schedule options.
* @since 2.3
*/
ScheduleOptions NOW(int times, long period);
@@ -161,9 +163,10 @@ public interface Scheduler {
/**
* Create a schedule options to fire a job once at a specific date
* @param date The date this job should be run.
+ * @return The schedule options.
* @since 2.3
*/
- ScheduleOptions AT(final Date date);
+ ScheduleOptions AT(Date date);
/**
* Create a schedule options to fire a job period starting at a specific
date
@@ -171,16 +174,18 @@ public interface Scheduler {
* @param times The number of times this job should be started (must be
higher than 1 or
* -1 for endless)
* @param period Every period seconds this job is started (must be at
higher than 0).
+ * @return The schedule options.
* @since 2.3
*/
- ScheduleOptions AT(final Date date, int times, long period);
+ ScheduleOptions AT(Date date, int times, long period);
/**
* Create a schedule options to schedule the job based on the expression
* @param expression The cron exception
+ * @return The schedule options.
* @since 2.3
*/
- ScheduleOptions EXPR(final String expression);
+ ScheduleOptions EXPR(String expression);
/**
/**
