Author: ieb
Date: Wed Oct 5 09:21:31 2016
New Revision: 1763369
URL: http://svn.apache.org/viewvc?rev=1763369&view=rev
Log:
SLING-5645 fixes to javadoc
Modified:
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/Job.java
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobCallback.java
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobManager.java
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobTypeValve.java
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobUpdate.java
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobUpdateListener.java
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/Types.java
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobImpl.java
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobManagerImpl.java
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobUpdateBuilderImpl.java
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/Utils.java
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/spi/JobStorage.java
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/spi/MapValueAdapter.java
Modified:
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/Job.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/Job.java?rev=1763369&r1=1763368&r2=1763369&view=diff
==============================================================================
---
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/Job.java
(original)
+++
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/Job.java
Wed Oct 5 09:21:31 2016
@@ -86,18 +86,21 @@ 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();
/**
* The time when the job started.
+ * @return the epch time in ms when the job was started.
*/
long getStarted();
@@ -109,13 +112,14 @@ public interface Job {
/**
* Get the job state
+ * @return the job state.
*/
@Nonnull
JobState getJobState();
/**
* Set the new state.
- * @param newState
+ * @param newState the new state.
*/
void setState(@Nonnull JobState newState);
@@ -135,6 +139,10 @@ public interface Job {
@Nullable
String getResultMessage();
+ /**
+ *
+ * @return a Job update builder.
+ */
@Nonnull
JobUpdateBuilder newJobUpdateBuilder();
@@ -148,6 +156,7 @@ public interface Job {
/**
* Set the current job controller.
+ * @param jobController the job controller.
*/
void setJobController(@Nonnull JobController jobController);
Modified:
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobCallback.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobCallback.java?rev=1763369&r1=1763368&r2=1763369&view=diff
==============================================================================
---
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobCallback.java
(original)
+++
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobCallback.java
Wed Oct 5 09:21:31 2016
@@ -31,7 +31,7 @@ public interface JobCallback {
/**
* Call back with an update job state.
- * @param finalJobState
+ * @param finalJobState job state.
*/
void callback(Job finalJobState);
}
Modified:
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobManager.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobManager.java?rev=1763369&r1=1763368&r2=1763369&view=diff
==============================================================================
---
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobManager.java
(original)
+++
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobManager.java
Wed Oct 5 09:21:31 2016
@@ -139,6 +139,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 to stop.
*/
void stopJobById(@Nonnull String jobId);
Modified:
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobTypeValve.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobTypeValve.java?rev=1763369&r1=1763368&r2=1763369&view=diff
==============================================================================
---
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobTypeValve.java
(original)
+++
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobTypeValve.java
Wed Oct 5 09:21:31 2016
@@ -32,7 +32,7 @@ public interface JobTypeValve {
/**
* Return true if the component, normally a JobConsumer, can process the
jobType.
- * @param jobType
+ * @param jobType the job type.
* @return true if can be processed.
*/
boolean accept(@Nonnull Types.JobType jobType);
Modified:
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobUpdate.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobUpdate.java?rev=1763369&r1=1763368&r2=1763369&view=diff
==============================================================================
---
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobUpdate.java
(original)
+++
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobUpdate.java
Wed Oct 5 09:21:31 2016
@@ -33,7 +33,7 @@ import java.util.Map;
* put the JobUpdates that start a message on a separate queue from the
JobUpdates that update, abort or stop a job, so that
* those messages do not get delayed by a backlog of job start messages.
Alternatively the implementation may decide to implement
* a scheduler that consumes job start messages at full queue throughput and
queue jobs into a separate implementation specific queue.
- * <p/>
+ * <p>
* The API does not specify the implementation, only that the various
JobUpdate messages are delivered with an delay appropriate for the
* type of message, identified by the JobUpdateCommand type.
*/
@@ -56,7 +56,7 @@ public interface JobUpdate {
* exist on the receiver the update message may be stored until the TTL
expires before it is applied. This allows
* messages sent out of order to wait till expires has been reached before
applying the update. The rules determining
* how expiring messages are applied is an implementation detail.
- * @return
+ * @return the epoch time in ms when the update expires.
*/
long expires();
@@ -125,18 +125,21 @@ public interface JobUpdate {
/**
* 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();
/**
* The time when the job started.
+ * @return epoch time when the job was started.
*/
long getStarted();
Modified:
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobUpdateListener.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobUpdateListener.java?rev=1763369&r1=1763368&r2=1763369&view=diff
==============================================================================
---
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobUpdateListener.java
(original)
+++
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/JobUpdateListener.java
Wed Oct 5 09:21:31 2016
@@ -31,7 +31,7 @@ public interface JobUpdateListener {
/**
* Update the job state with a message.
- * @param update
+ * @param update update message.
*/
void update(@Nonnull JobUpdate update);
}
Modified:
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/Types.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/Types.java?rev=1763369&r1=1763368&r2=1763369&view=diff
==============================================================================
---
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/Types.java
(original)
+++
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/Types.java
Wed Oct 5 09:21:31 2016
@@ -56,8 +56,8 @@ public final class Types {
/**
* Create a JobQueue from a string represtnation, normally this us a path
representing the jobQueue, although the path
* hierachy may not have any significance depending on the MoM
implementation.
- * @param jobQueue
- * @return
+ * @param jobQueue job queue name.
+ * @return the job queue.
*/
public static JobQueue jobQueue(String jobQueue) {
return new JobQueueImpl(jobQueue);
@@ -65,8 +65,8 @@ public final class Types {
/**
* Create a JobType from a string representation.
- * @param jobType
- * @return
+ * @param jobType job type name.
+ * @return job type.
*/
public static JobType jobType(String jobType) {
return new JobTypeImpl(jobType);
Modified:
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobImpl.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobImpl.java?rev=1763369&r1=1763368&r2=1763369&view=diff
==============================================================================
---
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobImpl.java
(original)
+++
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobImpl.java
Wed Oct 5 09:21:31 2016
@@ -147,7 +147,7 @@ public class JobImpl implements Job, Job
/**
* Apply an job update to this job, checking that the update is valid for
the job.
- * @param jobUpdate
+ * @param jobUpdate job update.
*/
@Override
public void update(@Nonnull JobUpdate jobUpdate) {
Modified:
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobManagerImpl.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobManagerImpl.java?rev=1763369&r1=1763368&r2=1763369&view=diff
==============================================================================
---
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobManagerImpl.java
(original)
+++
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobManagerImpl.java
Wed Oct 5 09:21:31 2016
@@ -49,8 +49,8 @@ public class JobManagerImpl implements
/**
*
- * @param jobStorage
- * @param messageSender
+ * @param jobStorage job storage used by the manager.
+ * @param messageSender the message sender that listens for updates.
*/
public JobManagerImpl(JobStorage jobStorage, JobUpdateListener
messageSender) {
this.jobStorage = jobStorage;
Modified:
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobUpdateBuilderImpl.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobUpdateBuilderImpl.java?rev=1763369&r1=1763368&r2=1763369&view=diff
==============================================================================
---
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobUpdateBuilderImpl.java
(original)
+++
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/JobUpdateBuilderImpl.java
Wed Oct 5 09:21:31 2016
@@ -38,7 +38,7 @@ public class JobUpdateBuilderImpl implem
/**
* Create a JobUpdateBuilder from a job.
- * @param job
+ * @param job the job.
*/
public JobUpdateBuilderImpl(@Nonnull Job job) {
this.job = job;
Modified:
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/Utils.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/Utils.java?rev=1763369&r1=1763368&r2=1763369&view=diff
==============================================================================
---
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/Utils.java
(original)
+++
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/Utils.java
Wed Oct 5 09:21:31 2016
@@ -97,7 +97,7 @@ public class Utils {
/**
* Generate an ID based on the unique name of the jvm process and a
counter.
- * @return
+ * @return a generated ID.
*/
@Nonnull
public static String generateId() {
Modified:
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/spi/JobStorage.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/spi/JobStorage.java?rev=1763369&r1=1763368&r2=1763369&view=diff
==============================================================================
---
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/spi/JobStorage.java
(original)
+++
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/spi/JobStorage.java
Wed Oct 5 09:21:31 2016
@@ -50,7 +50,7 @@ public interface JobStorage {
/**
* Remove the Job
- * @param jobId
+ * @param jobId the job id.
* @return the job removed or null if not present.
*/
@Nullable
Modified:
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/spi/MapValueAdapter.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/spi/MapValueAdapter.java?rev=1763369&r1=1763368&r2=1763369&view=diff
==============================================================================
---
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/spi/MapValueAdapter.java
(original)
+++
sling/trunk/contrib/commons/mom/jobs/core/src/main/java/org/apache/sling/jobs/impl/spi/MapValueAdapter.java
Wed Oct 5 09:21:31 2016
@@ -32,12 +32,12 @@ public interface MapValueAdapter {
/**
* Populate the object from a map value.
- * @param mapValue
+ * @param mapValue object representing the map value.
*/
void fromMapValue(Object mapValue);
/**
- * Adapt the object into a value suitable for use in a map to be
serialised by standard map -> json,yaml writers.
+ * Adapt the object into a value suitable for use in a map to be
serialised by standard map to json,yaml writers.
* @return a value, which may be a primitive, an array or a map of
primitives.
*/
Object toMapValue();
