Author: cziegeler
Date: Thu Jul 7 08:31:08 2016
New Revision: 1751759
URL: http://svn.apache.org/viewvc?rev=1751759&view=rev
Log:
Fix javadocs
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Job.java
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/JobManager.java
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Queue.java
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/QueueConfiguration.java
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/ScheduleInfo.java
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/ScheduledJobInfo.java
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Statistics.java
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/TopicStatistics.java
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionContext.java
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionResult.java
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Job.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Job.java?rev=1751759&r1=1751758&r2=1751759&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Job.java
(original)
+++
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Job.java
Thu Jul 7 08:31:08 2016
@@ -215,6 +215,7 @@ public interface Job {
*
* @param name The name of the property
* @param type The class of the type
+ * @param <T> The class of the type
* @return Return named value converted to type T or <code>null</code> if
* non existing or can't be converted.
*/
@@ -232,6 +233,7 @@ public interface Job {
* default value is also used to define the type to convert the
* value to. If this is <code>null</code> any existing property
is
* not converted.
+ * @param <T> The class of the type
* @return Return named value converted to type T or the default value if
* non existing or can't be converted.
*/
@@ -240,12 +242,14 @@ public interface Job {
/**
* On first execution the value of this property is zero.
* This property is managed by the job handling.
+ * @return The retry count.
*/
int getRetryCount();
/**
* The property to track the retry maximum retry count for jobs.
* This property is managed by the job handling.
+ * @return The number of retries.
*/
int getNumberOfRetries();
@@ -267,23 +271,27 @@ public interface Job {
* This property is set by the job handling and contains a calendar object
* specifying the date and time when this job has been started.
* This property is only set if the job is currently in processing
+ * @return The time the processing started or {@code null}.
*/
Calendar getProcessingStarted();
/**
* This property is set by the job handling and contains a calendar object
* specifying the date and time when this job has been created.
+ * @return The time the job was created.
*/
Calendar getCreated();
/**
* This property is set by the job handling and contains the Sling
instance ID
* of the instance where this job has been created.
+ * @return The instance id the job was created on
*/
String getCreatedInstance();
/**
* Get the job state
+ * @return The job state.
* @since 1.3
*/
JobState getJobState();
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/JobManager.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/JobManager.java?rev=1751759&r1=1751758&r2=1751759&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/JobManager.java
(original)
+++
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/JobManager.java
Thu Jul 7 08:31:08 2016
@@ -43,11 +43,13 @@ public interface JobManager {
/**
* Return statistics information about all queues.
+ * @return The statistics.
*/
Statistics getStatistics();
/**
* Return statistics information about job topics.
+ * @return The statistics for all topics.
*/
Iterable<TopicStatistics> getTopicStatistics();
@@ -60,6 +62,7 @@ public interface JobManager {
/**
* Return an iterator for all available queues.
+ * @return An iterator for all queues.
*/
Iterable<Queue> getQueues();
@@ -175,6 +178,7 @@ public interface JobManager {
* When a job is stopped and the job consumer supports stopping the job
processing, it is up
* to the job consumer how the stopping is handled. The job can be marked
as finished successful,
* permanently failed or being retried.
+ * @param jobId The job id
* @since 1.3
*/
void stopJobById(String jobId);
@@ -199,6 +203,7 @@ public interface JobManager {
/**
* Return all available job schedules.
+ * @return A collection of scheduled job infos
* @since 1.3
*/
Collection<ScheduledJobInfo> getScheduledJobs();
@@ -211,6 +216,7 @@ public interface JobManager {
* @param templates A list of filter property maps. Each map acts like a
template. The searched job
* must match the template (AND query). By providing
several maps, different filters
* are possible (OR query).
+ * @return All matching scheduled job infos.
* @since 1.4
*/
Collection<ScheduledJobInfo> getScheduledJobs(String topic, long limit,
Map<String, Object>... templates);
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Queue.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Queue.java?rev=1751759&r1=1751758&r2=1751759&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Queue.java
(original)
+++
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Queue.java
Thu Jul 7 08:31:08 2016
@@ -30,16 +30,19 @@ public interface Queue {
/**
* Get the queue name.
+ * @return The queue name
*/
String getName();
/**
* Return statistics information about this queue.
+ * @return The queue statistics
*/
Statistics getStatistics();
/**
* Get the corresponding configuration.
+ * @return The queue configuration
*/
QueueConfiguration getConfiguration();
@@ -66,6 +69,7 @@ public interface Queue {
/**
* Is the queue currently suspended?
+ * @return {code true} if the queue is supsended
*/
boolean isSuspended();
@@ -79,12 +83,15 @@ public interface Queue {
* Return some information about the current state of the queue. This
* method is meant to see the internal state of the queue for debugging
* or monitoring purposes.
+ * @return Additional state info
*/
String getStateInfo();
/**
* For monitoring purposes and possible extensions from the different
* queue types. This method allows to query state information.
+ * @param key The key for the state
+ * @return The state or {@code null}.
*/
Object getState(final String key);
}
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/QueueConfiguration.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/QueueConfiguration.java?rev=1751759&r1=1751758&r2=1751759&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/QueueConfiguration.java
(original)
+++
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/QueueConfiguration.java
Thu Jul 7 08:31:08 2016
@@ -47,31 +47,37 @@ public interface QueueConfiguration {
/**
* Return the retry delay in ms
+ * @return The retry delay
*/
long getRetryDelayInMs();
/**
* Return the max number of retries, -1 for endless retry!
+ * @return Max number of retries
*/
int getMaxRetries();
/**
* Return the queue type.
+ * @return The queue type
*/
Type getType();
/**
* Return the thread priority for the job thread
+ * @return Thread priority
*/
ThreadPriority getThreadPriority();
/**
* Return the max number of parallel processes.
+ * @return Max parallel processes
*/
int getMaxParallel();
/**
* The list of topics this queue is bound to.
+ * @return All topics for this queue.
*/
String[] getTopics();
@@ -92,11 +98,13 @@ public interface QueueConfiguration {
/**
* Get the ranking of this configuration.
+ * @return The ranking
*/
int getRanking();
/**
* Prefer to run the job on the same instance it was created on.
+ * @return {@code true} if running on the creation instance is preferred.
* @since 1.4
*/
boolean isPreferRunOnCreationInstance();
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/ScheduleInfo.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/ScheduleInfo.java?rev=1751759&r1=1751758&r2=1751759&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/ScheduleInfo.java
(original)
+++
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/ScheduleInfo.java
Thu Jul 7 08:31:08 2016
@@ -47,6 +47,7 @@ public interface ScheduleInfo {
/**
* Return the scheduled execution date for a schedule of type date.
+ * @return the scheduled execution date
*/
Date getAt();
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/ScheduledJobInfo.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/ScheduledJobInfo.java?rev=1751759&r1=1751758&r2=1751759&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/ScheduledJobInfo.java
(original)
+++
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/ScheduledJobInfo.java
Thu Jul 7 08:31:08 2016
@@ -39,6 +39,7 @@ public interface ScheduledJobInfo {
/**
* Return the next scheduled execution date.
+ * @return the next scheduled execution date.
*/
Date getNextScheduledExecution();
@@ -63,6 +64,7 @@ public interface ScheduledJobInfo {
* Reschedule this job with a new rescheduling information.
* If rescheduling fails (due to wrong arguments), the job
* schedule is left as is.
+ * @return The schedule builder
*/
JobBuilder.ScheduleBuilder reschedule();
@@ -81,6 +83,7 @@ public interface ScheduledJobInfo {
/**
* Is the processing currently suspended?
+ * @return {@code true} if processing is suspended.
*/
boolean isSuspended();
}
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Statistics.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Statistics.java?rev=1751759&r1=1751758&r2=1751759&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Statistics.java
(original)
+++
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/Statistics.java
Thu Jul 7 08:31:08 2016
@@ -31,21 +31,25 @@ public interface Statistics {
/**
* The time this service has been started
+ * @return The time this service has been started
*/
long getStartTime();
/**
* Number of successfully finished jobs.
+ * @return Number of successfully finished jobs.
*/
long getNumberOfFinishedJobs();
/**
* Number of permanently failing or cancelled jobs.
+ * @return Number of permanently failing or cancelled jobs
*/
long getNumberOfCancelledJobs();
/**
* Number of failing jobs.
+ * @return Number of failing jobs.
*/
long getNumberOfFailedJobs();
@@ -53,41 +57,49 @@ public interface Statistics {
* Number of already processed jobs. This adds
* {@link #getNumberOfFinishedJobs()}, {@link #getNumberOfCancelledJobs()}
* and {@link #getNumberOfFailedJobs()}
+ * @return Number of already processed jobs
*/
long getNumberOfProcessedJobs();
/**
* Number of jobs currently in processing.
+ * @return Number of jobs currently in processing.
*/
long getNumberOfActiveJobs();
/**
* Number of jobs currently waiting in a queue.
+ * @return Number of jobs currently waiting in a queue.
*/
long getNumberOfQueuedJobs();
/**
* This just adds {@link #getNumberOfActiveJobs()} and {@link
#getNumberOfQueuedJobs()}
+ * @return The number of jobs
*/
long getNumberOfJobs();
/**
* The time a job has been started last.
+ * @return The time a job has been started last.
*/
long getLastActivatedJobTime();
/**
* The time a job has been finished/failed/cancelled last.
+ * @return The time a job has been finished/failed/cancelled last.
*/
long getLastFinishedJobTime();
/**
* The average waiting time of a job in the queue.
+ * @return The average waiting time of a job in the queue.
*/
long getAverageWaitingTime();
/**
* The average processing time of a job - this only counts finished jobs.
+ * @return The average processing time of a job
*/
long getAverageProcessingTime();
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/TopicStatistics.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/TopicStatistics.java?rev=1751759&r1=1751758&r2=1751759&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/TopicStatistics.java
(original)
+++
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/TopicStatistics.java
Thu Jul 7 08:31:08 2016
@@ -31,21 +31,25 @@ public interface TopicStatistics {
/**
* The topic this statistics is about.
+ * @return The topic name
*/
String getTopic();
/**
* Number of successfully finished jobs.
+ * @return Number of successfully finished jobs.
*/
long getNumberOfFinishedJobs();
/**
* Number of permanently failing or cancelled jobs.
+ * @return Number of permanently failing or cancelled jobs.
*/
long getNumberOfCancelledJobs();
/**
* Number of failing jobs.
+ * @return Number of failing jobs.
*/
long getNumberOfFailedJobs();
@@ -53,26 +57,31 @@ public interface TopicStatistics {
* Number of already processed jobs. This adds
* {@link #getNumberOfFinishedJobs()}, {@link #getNumberOfCancelledJobs()}
* and {@link #getNumberOfFailedJobs()}
+ * @return Number of already processed jobs.
*/
long getNumberOfProcessedJobs();
/**
* The time a job has been started last.
+ * @return The time a job has been started last.
*/
long getLastActivatedJobTime();
/**
* The time a job has been finished/failed/cancelled last.
+ * @return The time a job has been finished/failed/cancelled last.
*/
long getLastFinishedJobTime();
/**
* The average waiting time of a job in the queue.
+ * @return The average waiting time of a job in the queue.
*/
long getAverageWaitingTime();
/**
* The average processing time of a job - this only counts finished jobs.
+ * @return The average processing time of a job
*/
long getAverageProcessingTime();
}
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=1751759&r1=1751758&r2=1751759&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:31:08 2016
@@ -102,6 +102,7 @@ public interface JobExecutionContext {
/**
* Build a result for the processing.
+ * @return The build for the result
*/
ResultBuilder result();
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionResult.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionResult.java?rev=1751759&r1=1751758&r2=1751759&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionResult.java
(original)
+++
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionResult.java
Thu Jul 7 08:31:08 2016
@@ -65,7 +65,7 @@ public interface JobExecutionResult {
/**
* Return the retry delay in ms
- * @return The new retry delay (>= 0) or <code>null</code>
+ * @return The new retry delay (>= 0) or <code>null</code>
*/
Long getRetryDelayInMs();
}
