Author: cziegeler
Date: Thu Jul 7 08:09:06 2016
New Revision: 1751754
URL: http://svn.apache.org/viewvc?rev=1751754&view=rev
Log:
Fix some javadocs
Modified:
sling/trunk/bundles/extensions/event/pom.xml
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/impl/jobs/queues/QueueJobCache.java
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/impl/jobs/queues/QueueManager.java
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionContext.java
Modified: sling/trunk/bundles/extensions/event/pom.xml
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/pom.xml?rev=1751754&r1=1751753&r2=1751754&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/event/pom.xml (original)
+++ sling/trunk/bundles/extensions/event/pom.xml Thu Jul 7 08:09:06 2016
@@ -200,7 +200,7 @@
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<excludePackageNames>
-
org.apache.sling.event.impl,org.apache.sling.event.impl.job,org.apache.sling.event.impl.jobs,org.apache.sling.event.impl.jobs.console,org.apache.sling.event.impl.jobs.queue
+
org.apache.sling.event.impl,org.apache.sling.event.impl.jobs,org.apache.sling.event.impl.jobs.config,org.apache.sling.event.impl.jobs.console,org.apache.sling.event.impl.jobs.jmx,org.apache.sling.event.impl.jobs.notifications,org.apache.sling.event.impl.jobs.queues,org.apache.sling.event.impl.jobs.scheduling,org.apache.sling.event.impl.jobs.stats,org.apache.sling.event.impl.jobs.tasks,org.apache.sling.event.impl.support
</excludePackageNames>
</configuration>
</plugin>
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/impl/jobs/queues/QueueJobCache.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/impl/jobs/queues/QueueJobCache.java?rev=1751754&r1=1751753&r2=1751754&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/impl/jobs/queues/QueueJobCache.java
(original)
+++
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/impl/jobs/queues/QueueJobCache.java
Thu Jul 7 08:09:06 2016
@@ -78,6 +78,8 @@ public class QueueJobCache {
/**
* Create a new queue job cache
* @param configuration Current job manager configuration
+ * @param queueName The queue name
+ * @param statisticsManager The statistics manager
* @param queueType The queue type
* @param topics The topics handled by this queue.
*/
@@ -136,8 +138,13 @@ public class QueueJobCache {
/**
* Get the next job.
* This method is potentially called concurrently, and
- * {@link #reschedule(JobHandler)} and {@link #handleNewTopics(Set)}
+ * {@link #reschedule(String, JobHandler, StatisticsManager)} and {@link
#handleNewTopics(Set)}
* can be called concurrently.
+ * @param jobConsumerManager The job consumer manager
+ * @param statisticsManager The statistics manager
+ * @param queue The queue
+ * @param doFull Whether to do a full scan
+ * @return The job handler or {@code null}.
*/
public JobHandler getNextJob(final JobConsumerManager jobConsumerManager,
final StatisticsManager statisticsManager,
@@ -318,7 +325,9 @@ public class QueueJobCache {
/**
* Reschedule a job
* Reschedule the job and add it back into the cache.
+ * @param queueName The queue name
* @param handler The job handler
+ * @param statisticsManager The statistics manager
*/
public void reschedule(final String queueName, final JobHandler handler,
final StatisticsManager statisticsManager) {
synchronized ( this.cache ) {
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/impl/jobs/queues/QueueManager.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/impl/jobs/queues/QueueManager.java?rev=1751754&r1=1751753&r2=1751754&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/impl/jobs/queues/QueueManager.java
(original)
+++
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/impl/jobs/queues/QueueManager.java
Thu Jul 7 08:09:06 2016
@@ -310,6 +310,8 @@ public class QueueManager
}
/**
+ * @param name The queue name
+ * @return The queue or {@code null}.
* @see org.apache.sling.event.jobs.JobManager#getQueue(java.lang.String)
*/
public Queue getQueue(final String name) {
@@ -317,6 +319,7 @@ public class QueueManager
}
/**
+ * @return An iterator for the available queues.
* @see org.apache.sling.event.jobs.JobManager#getQueues()
*/
public Iterable<Queue> getQueues() {
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionContext.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionContext.java?rev=1751754&r1=1751753&r2=1751754&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionContext.java
(original)
+++
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionContext.java
Thu Jul 7 08:09:06 2016
@@ -29,10 +29,11 @@ public interface JobExecutionContext {
/**
* Report an async result.
+ * @param result Tje job execution result
* @throws IllegalStateException If the job is not processed asynchronously
* or if this method has already been called.
*/
- void asyncProcessingFinished(final JobExecutionResult result);
+ void asyncProcessingFinished(JobExecutionResult result);
/**
* If a job is stoppable, it should periodically check this method
@@ -42,6 +43,7 @@ public interface JobExecutionContext {
* There might be use cases where the job returns {@link
JobExecutionResult#succeeded()}
* although it didn't process everything, or {@link
JobExecutionResult#failed()}
* to retry later on or {@link JobExecutionResult#cancelled()}.
+ *
* @return Whether this job has been stopped from the outside.
*/
boolean isStopped();
@@ -61,7 +63,7 @@ public interface JobExecutionContext {
* @param eta Number of seconds the process should take or
* -1 of it's not known now.
*/
- void initProgress(final int steps, final long eta);
+ void initProgress(int steps, long eta);
/**
* Update the progress by additionally marking the provided
@@ -73,7 +75,7 @@ public interface JobExecutionContext {
* has been called first with a positive number for steps
* @param steps The number of finished steps since the last call.
*/
- void incrementProgressCount(final int steps);
+ void incrementProgressCount(int steps);
/**
* Update the progress to the new ETA.
@@ -81,7 +83,7 @@ public interface JobExecutionContext {
* has been called first.
* @param eta The new ETA
*/
- void updateProgress(final long eta);
+ void updateProgress(long eta);
/**
* Log a message.
@@ -96,7 +98,7 @@ public interface JobExecutionContext {
* @param message A message
* @param args Additional arguments
*/
- void log(final String message, final Object...args);
+ void log(String message, Object...args);
/**
* Build a result for the processing.
@@ -108,27 +110,33 @@ public interface JobExecutionContext {
/**
* Add an optional processing message.
* This message can be viewed using {@link
org.apache.sling.event.jobs.Job#getResultMessage()}.
+ * @param message The message
+ * @return The builder to continue building the result.
*/
- ResultBuilder message(final String message);
+ ResultBuilder message(String message);
/**
* The job processing finished successfully.
+ * @return The job execution result.
*/
JobExecutionResult succeeded();
/**
* The job processing failed and might be retried.
+ * @return The job execution result.
*/
JobExecutionResult failed();
/**
* The job processing failed and might be retried.
* @param retryDelayInMs The new retry delay in ms.
+ * @return The job execution result
*/
- JobExecutionResult failed(final long retryDelayInMs);
+ JobExecutionResult failed(long retryDelayInMs);
/**
* The job processing failed permanently.
+ * @return The job execution result
*/
JobExecutionResult cancelled();
}
