Add missing javadocs

Author: Crim

src/main/java/org/sourcelab/storm/spout/redis/FailureHandler.java

@@ -13,6 +13,7 @@ public interface FailureHandler extends Serializable {
     /**
      * Lifecycle method.  Called once the Spout has started.
      * @param stormConfig Configuration map passed from the spout.
+     * @param topologyContext Storm TopologyContext instance.
      */
     void open(final Map<String, Object> stormConfig, final TopologyContext topologyContext);
 

src/main/java/org/sourcelab/storm/spout/redis/client/Client.java

@@ -15,6 +15,7 @@ public interface Client {
 
     /**
      * Retrieve the next batch of messages from Redis Stream.
+     * @return List of next Messages consumed from Redis Stream.
      */
     List<Message> nextMessages();
 

src/main/java/org/sourcelab/storm/spout/redis/client/LettuceAdapter.java

@@ -20,6 +20,7 @@ public interface LettuceAdapter {
 
     /**
      * Get sync Redis Stream Commands instance.
+     * @return Available synchronous stream commands.
      */
     RedisStreamCommands<String, String> getSyncCommands();
 

src/main/java/org/sourcelab/storm/spout/redis/failhandler/ExponentialBackoffConfig.java

@@ -39,7 +39,14 @@ public class ExponentialBackoffConfig implements Serializable {
     private final boolean metricsEnabled;
 
     /**
-     * Constructor.  See Builder instance.
+     * Constructor.
+     * See {@link Builder} instance.
+     *
+     * @param retryLimit How many times to attempt to retry a failed message. Defaults to 10.
+     * @param initialRetryDelayMs Define minimum retry delay, in milliseconds. Defaults to 2000.
+     * @param retryDelayMultiplier At what rate to delay messages that continue to fail.  Defaults to 2.0.
+     * @param retryDelayMaxMs Maximum cap on time delay for failed messages.  Default to 10 minutes.
+     * @param metricsEnabled If true, metrics will be published about failed messages.
      */
     public ExponentialBackoffConfig(
         final int retryLimit,
@@ -119,6 +126,7 @@ public static final class Builder {
 
         /**
          * Default multiplier to 2.0.
+         * This default value gives us an exponential backoff rate.
          */
         private double retryDelayMultiplier = 2.0;
 

src/main/java/org/sourcelab/storm/spout/redis/failhandler/RetryFailedTuples.java

@@ -17,13 +17,15 @@
  * A value greater than 0 sets the upper limit on the number of times a message will fail before just being skipped.
  * A value equal to 0 says failed messages will NEVER be replayed.
  * A value less than 0 says ALWAYS replay failed messages until they are successful.
+ *
+ * Recommended to use {@link ExponentialBackoffFailureHandler} instead of this naive implementation.
  */
 public class RetryFailedTuples implements FailureHandler, Serializable {
     private static final Logger logger = LoggerFactory.getLogger(RetryFailedTuples.class);
 
     /**
      * This tracks how many times a specific msgId has been replayed.
-     * MsgId => Number of times we've replayed it.
+     * Maps MsgId to the Number of times it has been replayed.
      */
     private final Map<String, Long> messageCounter = new HashMap<>();
 

src/main/java/org/sourcelab/storm/spout/redis/funnel/MemoryFunnel.java

@@ -53,13 +53,16 @@ public class MemoryFunnel implements SpoutFunnel, ConsumerFunnel {
     /**
      * Constructor.
      * @param config configuration proeprties.
+     * @param topologyContext Storm TopologyContext instance.
      */
     public MemoryFunnel(
         final RedisStreamSpoutConfig config,
         final Map<String, Object> stormConfig,
         final TopologyContext topologyContext
     ) {
         Objects.requireNonNull(config);
+        Objects.requireNonNull(config);
+        Objects.requireNonNull(topologyContext);
 
         // These DO need to be concurrent.
         inFlightTuples = new ConcurrentHashMap<>(config.getMaxTupleQueueSize());