Polishing

* Typo fixes * Reorder methods in rx impl
mp911de · Dec 25, 2015 · e0932b8 · e0932b8
1 parent 80542ad
commit e0932b8
Show file tree

Hide file tree

Showing 9 changed files with 210 additions and 210 deletions.
diff --git a/src/main/java/biz/paluch/spinach/api/JScanArgs.java b/src/main/java/biz/paluch/spinach/api/JScanArgs.java
@@ -108,7 +108,7 @@ public Builder<K> busyloop(boolean busyloop) {
         /**
          * Scan a specific queue
          * 
-         * @param queue id of the queue
+         * @param queue the queue name
          * @return the current builder
          */
         public Builder<K> queue(K queue) {

diff --git a/src/main/java/biz/paluch/spinach/api/async/DisqueJobAsyncCommands.java b/src/main/java/biz/paluch/spinach/api/async/DisqueJobAsyncCommands.java
@@ -30,9 +30,9 @@ public interface DisqueJobAsyncCommands<K, V> {
     RedisFuture<Long> ackjob(String... jobIds);
 
     /**
-     * Add job tot the {@code queue} with the body of {@code job}
+     * Add a job to the {@code queue} with the body {@code job}.
      *
-     * @param queue the target queue
+     * @param queue the queue name
      * @param job job body
      * @param timeout TTL timeout
      * @param timeUnit TTL timeout time unit
@@ -42,9 +42,9 @@ public interface DisqueJobAsyncCommands<K, V> {
 
     /**
      *
-     * Add job tot the {@code queue} with the body of {@code job}
+     * Add a job to the {@code queue} with the body {@code job}.
      *
-     * @param queue the target queue
+     * @param queue the queue name
      * @param job job body
      * @param timeout TTL timeout
      * @param timeUnit TTL timeout time unit
@@ -75,15 +75,15 @@ public interface DisqueJobAsyncCommands<K, V> {
      * connection. If timeout is given, the command will block until given timeout and return null.
      *
      * @param getJobArgs job arguments
-     * @param queues the queue
+     * @param queues the queue names
      * @return the job or null
      */
     RedisFuture<Job<K, V>> getjob(GetJobArgs getJobArgs, K... queues);
 
     /**
      * Get jobs from the specified queue. If there are no jobs in any of the specified queues the command block.
      *
-     * @param queues queue names
+     * @param queues the queue names
      * @return the job or null
      */
     RedisFuture<Job<K, V>> getjob(K... queues);
@@ -94,7 +94,7 @@ public interface DisqueJobAsyncCommands<K, V> {
      *
      * @param timeout max timeout to wait
      * @param timeUnit timeout unit
-     * @param queues queue names
+     * @param queues the queue names
      * @return the job or null
      */
     RedisFuture<Job<K, V>> getjob(long timeout, TimeUnit timeUnit, K... queues);
@@ -114,7 +114,7 @@ public interface DisqueJobAsyncCommands<K, V> {
      *
      * @param getJobArgs job arguments
      * @param count count of jobs to return
-     * @param queues queue names
+     * @param queues the queue names
      * @return the jobs
      */
     RedisFuture<List<Job<K, V>>> getjobs(GetJobArgs getJobArgs, long count, K... queues);
@@ -123,7 +123,7 @@ public interface DisqueJobAsyncCommands<K, V> {
      * Get jobs from the specified queues. If there are no jobs in any of the specified queues the command will block the
      * connection.
      *
-     * @param queues queue names
+     * @param queues the queue names
      * @return the jobs
      */
     RedisFuture<List<Job<K, V>>> getjobs(K... queues);
@@ -144,7 +144,7 @@ public interface DisqueJobAsyncCommands<K, V> {
      * @param timeout timeout to wait
      * @param timeUnit timeout unit
      * @param count count of jobs to return
-     * @param queues queue names
+     * @param queues the queue names
      * @return the jobs
      */
     RedisFuture<List<Job<K, V>>> getjobs(long timeout, TimeUnit timeUnit, long count, K... queues);

diff --git a/src/main/java/biz/paluch/spinach/api/async/DisqueQueueAsyncCommands.java b/src/main/java/biz/paluch/spinach/api/async/DisqueQueueAsyncCommands.java
@@ -53,7 +53,7 @@ public interface DisqueQueueAsyncCommands<K, V> {
      * <li>Broadcast the pause state</li>
      * </ul>
      * 
-     * @param queue the queue
+     * @param queue the queue name
      * @param pauseArgs the pause args
      * @return pause state of the queue.
      */
@@ -62,7 +62,7 @@ public interface DisqueQueueAsyncCommands<K, V> {
     /**
      * Return the number of jobs queued.
      * 
-     * @param queue the queue
+     * @param queue the queue name
      * @return the number of jobs queued
      */
     RedisFuture<Long> qlen(K queue);
@@ -71,7 +71,7 @@ public interface DisqueQueueAsyncCommands<K, V> {
      * Return an array of at most "count" jobs available inside the queue "queue" without removing the jobs from the queue. This
      * is basically an introspection and debugging command.
      * 
-     * @param queue the queue
+     * @param queue the queue name
      * @param count number of jobs to return
      * @return List of jobs.
      */
@@ -112,8 +112,8 @@ public interface DisqueQueueAsyncCommands<K, V> {
     /**
      * Retrieve information about a queue as key value pairs.
      * 
-     * @param queue the queue
-     * @return map containing the statistics (Key-Value pairs)
+     * @param queue the queue name
+     * @return map containing the statistics (key value pairs)
      */
     RedisFuture<Map<String, Object>> qstat(K queue);
 

diff --git a/src/main/java/biz/paluch/spinach/api/rx/DisqueJobReactiveCommands.java b/src/main/java/biz/paluch/spinach/api/rx/DisqueJobReactiveCommands.java
@@ -30,9 +30,9 @@ public interface DisqueJobReactiveCommands<K, V> {
     Observable<Long> ackjob(String... jobIds);
 
     /**
-     * Add job tot the {@code queue} with the body of {@code job}
+     * Add a job to the {@code queue} with the body {@code job}.
      *
-     * @param queue the target queue
+     * @param queue the queue name
      * @param job job body
      * @param timeout TTL timeout
      * @param timeUnit TTL timeout time unit
@@ -42,9 +42,9 @@ public interface DisqueJobReactiveCommands<K, V> {
 
     /**
      *
-     * Add job tot the {@code queue} with the body of {@code job}
+     * Add a job to the {@code queue} with the body {@code job}.
      *
-     * @param queue the target queue
+     * @param queue the queue name
      * @param job job body
      * @param timeout TTL timeout
      * @param timeUnit TTL timeout time unit
@@ -75,7 +75,7 @@ public interface DisqueJobReactiveCommands<K, V> {
      * connection. If timeout is given, the command will block until given timeout and return null.
      *
      * @param getJobArgs job arguments
-     * @param queues the queue
+     * @param queues the queue name
      * @return the job or null
      */
     Observable<Job<K, V>> getjob(GetJobArgs getJobArgs, K... queues);
@@ -84,7 +84,7 @@ public interface DisqueJobReactiveCommands<K, V> {
      * Get jobs from the specified queue. If there are no jobs in any of the specified queues the command will block the
      * connection.
      *
-     * @param queues queue names
+     * @param queues the queue names
      * @return the job or null
      */
     Observable<Job<K, V>> getjob(K... queues);
@@ -95,7 +95,7 @@ public interface DisqueJobReactiveCommands<K, V> {
      *
      * @param timeout max timeout to wait
      * @param timeUnit timeout unit
-     * @param queues queue names
+     * @param queues the queue names
      * @return the job or null
      */
     Observable<Job<K, V>> getjob(long timeout, TimeUnit timeUnit, K... queues);
@@ -115,7 +115,7 @@ public interface DisqueJobReactiveCommands<K, V> {
      *
      * @param getJobArgs job arguments
      * @param count count of jobs to return
-     * @param queues queue names
+     * @param queues the queue names
      * @return the jobs
      */
     Observable<Job<K, V>> getjobs(GetJobArgs getJobArgs, long count, K... queues);
@@ -124,7 +124,7 @@ public interface DisqueJobReactiveCommands<K, V> {
      * Get jobs from the specified queues. If there are no jobs in any of the specified queues the command will block the
      * connection.
      *
-     * @param queues queue names
+     * @param queues the queue names
      * @return the jobs
      */
     Observable<Job<K, V>> getjobs(K... queues);
@@ -145,7 +145,7 @@ public interface DisqueJobReactiveCommands<K, V> {
      * @param timeout timeout to wait
      * @param timeUnit timeout unit
      * @param count count of jobs to return
-     * @param queues queue names
+     * @param queues the queue names
      * @return the jobs
      */
     Observable<Job<K, V>> getjobs(long timeout, TimeUnit timeUnit, long count, K... queues);

diff --git a/src/main/java/biz/paluch/spinach/api/rx/DisqueQueueReactiveCommands.java b/src/main/java/biz/paluch/spinach/api/rx/DisqueQueueReactiveCommands.java
@@ -52,7 +52,7 @@ public interface DisqueQueueReactiveCommands<K, V> {
      * <li>Broadcast the pause state</li>
      * </ul>
      * 
-     * @param queue the queue
+     * @param queue the queue name
      * @param pauseArgs the pause args
      * @return pause state of the queue.
      */
@@ -61,7 +61,7 @@ public interface DisqueQueueReactiveCommands<K, V> {
     /**
      * Return the number of jobs queued.
      * 
-     * @param queue the queue
+     * @param queue the queue name
      * @return the number of jobs queued
      */
     Observable<Long> qlen(K queue);
@@ -70,7 +70,7 @@ public interface DisqueQueueReactiveCommands<K, V> {
      * Return an array of at most "count" jobs available inside the queue "queue" without removing the jobs from the queue. This
      * is basically an introspection and debugging command.
      * 
-     * @param queue the queue
+     * @param queue the queue name
      * @param count number of jobs to return
      * @return List of jobs.
      */
@@ -111,8 +111,8 @@ public interface DisqueQueueReactiveCommands<K, V> {
     /**
      * Retrieve information about a queue as key value pairs.
      * 
-     * @param queue the queue
-     * @return map containing the statistics (Key-Value pairs)
+     * @param queue the queue name
+     * @return map containing the statistics (key value pairs)
      */
     Observable<Map<String, Object>> qstat(K queue);
 

diff --git a/src/main/java/biz/paluch/spinach/api/sync/DisqueJobCommands.java b/src/main/java/biz/paluch/spinach/api/sync/DisqueJobCommands.java
@@ -30,9 +30,9 @@ public interface DisqueJobCommands<K, V> {
     long ackjob(String... jobIds);
 
     /**
-     * Add job tot the {@code queue} with the body of {@code job}
+     * Add a job to the {@code queue} with the body {@code job}.
      *
-     * @param queue the target queue
+     * @param queue the queue name
      * @param job job body
      * @param timeout TTL timeout
      * @param timeUnit TTL timeout time unit
@@ -42,9 +42,9 @@ public interface DisqueJobCommands<K, V> {
 
     /**
      *
-     * Add job tot the {@code queue} with the body of {@code job}
+     * Add a job to the {@code queue} with the body {@code job}.
      *
-     * @param queue the target queue
+     * @param queue the queue name
      * @param job job body
      * @param timeout TTL timeout
      * @param timeUnit TTL timeout time unit
@@ -75,7 +75,7 @@ public interface DisqueJobCommands<K, V> {
      * connection. If timeout is given, the command will block until given timeout and return null.
      *
      * @param getJobArgs job arguments
-     * @param queues the queue
+     * @param queues the queue names
      * @return the job or null
      */
     Job<K, V> getjob(GetJobArgs getJobArgs, K... queues);
@@ -84,7 +84,7 @@ public interface DisqueJobCommands<K, V> {
      * Get jobs from the specified queue. If there are no jobs in any of the specified queues the command will block the
      * connection.
      *
-     * @param queues queue names
+     * @param queues the queue names
      * @return the job or null
      */
     Job<K, V> getjob(K... queues);
@@ -95,7 +95,7 @@ public interface DisqueJobCommands<K, V> {
      *
      * @param timeout max timeout to wait
      * @param timeUnit timeout unit
-     * @param queues queue names
+     * @param queues the queue names
      * @return the job or null
      */
     Job<K, V> getjob(long timeout, TimeUnit timeUnit, K... queues);
@@ -115,7 +115,7 @@ public interface DisqueJobCommands<K, V> {
      *
      * @param getJobArgs job arguments
      * @param count count of jobs to return
-     * @param queues queue names
+     * @param queues the queue names
      * @return the jobs
      */
     List<Job<K, V>> getjobs(GetJobArgs getJobArgs, long count, K... queues);
@@ -124,7 +124,7 @@ public interface DisqueJobCommands<K, V> {
      * Get jobs from the specified queues. If there are no jobs in any of the specified queues the command will block the
      * connection.
      *
-     * @param queues queue names
+     * @param queues the queue names
      * @return the jobs
      */
     List<Job<K, V>> getjobs(K... queues);
@@ -145,7 +145,7 @@ public interface DisqueJobCommands<K, V> {
      * @param timeout timeout to wait
      * @param timeUnit timeout unit
      * @param count count of jobs to return
-     * @param queues queue names
+     * @param queues the queue names
      * @return the jobs
      */
     List<Job<K, V>> getjobs(long timeout, TimeUnit timeUnit, long count, K... queues);

diff --git a/src/main/java/biz/paluch/spinach/api/sync/DisqueQueueCommands.java b/src/main/java/biz/paluch/spinach/api/sync/DisqueQueueCommands.java
@@ -53,7 +53,7 @@ public interface DisqueQueueCommands<K, V> {
      * <li>Broadcast the pause state</li>
      * </ul>
      * 
-     * @param queue the queue
+     * @param queue the queue name
      * @param pauseArgs the pause args
      * @return pause state of the queue.
      */
@@ -62,7 +62,7 @@ public interface DisqueQueueCommands<K, V> {
     /**
      * Return the number of jobs queued.
      *
-     * @param queue the queue
+     * @param queue the queue name
      * @return the number of jobs queued
      */
     long qlen(K queue);
@@ -71,7 +71,7 @@ public interface DisqueQueueCommands<K, V> {
      * Return an array of at most "count" jobs available inside the queue "queue" without removing the jobs from the queue. This
      * is basically an introspection and debugging command.
      *
-     * @param queue the queue
+     * @param queue the queue name
      * @param count number of jobs to return
      * @return List of jobs.
      */
@@ -112,8 +112,8 @@ public interface DisqueQueueCommands<K, V> {
     /**
      * Retrieve information about a queue as key value pairs.
      * 
-     * @param queue the queue
-     * @return map containing the statistics (Key-Value pairs)
+     * @param queue the queue name
+     * @return map containing the statistics (key value pairs)
      */
     Map<String, Object> qstat(K queue);
 

diff --git a/src/main/java/biz/paluch/spinach/cluster/QueueListenerFactory.java b/src/main/java/biz/paluch/spinach/cluster/QueueListenerFactory.java
@@ -86,7 +86,7 @@ protected QueueListenerFactory(DisqueClient disqueClient, Scheduler scheduler, D
      * 
      * @param disqueURI the DisqueURI
      * @param codec use this codec to encode/decode keys and values, must note be {@literal null}
-     * @param queues queue names
+     * @param queues the queue names
      * @param <K> Key type
      * @param <V> Value type
      * @return a new instance of {@link QueueListenerFactory}
@@ -102,7 +102,7 @@ public static <K, V> QueueListenerFactory<K, V> create(DisqueURI disqueURI, Redi
      * @param scheduler a scheduler from rxjava for I/O operations
      * @param disqueURI the DisqueURI
      * @param codec use this codec to encode/decode keys and values, must note be {@literal null}
-     * @param queues queue names
+     * @param queues the queue names
      * @param <K> Key type
      * @param <V> Value type
      * @return a new instance of {@link QueueListenerFactory}
@@ -120,7 +120,7 @@ public static <K, V> QueueListenerFactory<K, V> create(Scheduler scheduler, Disq
      * @param scheduler a scheduler from rxjava for I/O operations, must not be {@literal null}
      * @param disqueURI the DisqueURI
      * @param codec use this codec to encode/decode keys and values, must note be {@literal null}
-     * @param queues queue names
+     * @param queues the queue names
      * @param <K> Key type
      * @param <V> Value type
      * @return a new instance of {@link QueueListenerFactory}