Resolves checkstyle errors for callback, chain, circuit-breaker (iluwatar#1060)

altaiezior · iluwatar · commit 31f27a720b3e · 2019-11-09T21:27:14.000+02:00
* Reduces checkstyle errors in callback

* Reduces checkstyle errors in chain

* Reduces checkstyle errors in circuit-breaker
diff --git a/callback/src/main/java/com/iluwatar/callback/App.java b/callback/src/main/java/com/iluwatar/callback/App.java
@@ -23,16 +23,14 @@
 
 package com.iluwatar.callback;
 
-import org.slf4j.Logger;
-
 import static org.slf4j.LoggerFactory.getLogger;
 
+import org.slf4j.Logger;
+
 /**
- *
- * Callback pattern is more native for functional languages where functions are
- * treated as first-class citizens. Prior to Java 8 callbacks can be simulated
- * using simple (alike command) interfaces.
- *
+ * Callback pattern is more native for functional languages where functions are treated as
+ * first-class citizens. Prior to Java 8 callbacks can be simulated using simple (alike command)
+ * interfaces.
  */
 public final class App {
 
@@ -42,7 +40,7 @@ private App() {
   }
 
   /**
-   * Program entry point
+   * Program entry point.
    */
   public static void main(final String[] args) {
     Task task = new SimpleTask();
diff --git a/callback/src/main/java/com/iluwatar/callback/Callback.java b/callback/src/main/java/com/iluwatar/callback/Callback.java
@@ -24,9 +24,7 @@
 package com.iluwatar.callback;
 
 /**
- *
- * Callback interface
- *
+ * Callback interface.
  */
 public interface Callback {
 
diff --git a/callback/src/main/java/com/iluwatar/callback/LambdasApp.java b/callback/src/main/java/com/iluwatar/callback/LambdasApp.java
@@ -23,24 +23,23 @@
 
 package com.iluwatar.callback;
 
-import org.slf4j.Logger;
-
 import static org.slf4j.LoggerFactory.getLogger;
 
+import org.slf4j.Logger;
+
 /**
- *
- * This example generates the exact same output as {@link App} however the
- * callback has been defined as a Lambdas expression.
- *
+ * This example generates the exact same output as {@link App} however the callback has been defined
+ * as a Lambdas expression.
  */
 public final class LambdasApp {
 
   private static final Logger LOGGER = getLogger(LambdasApp.class);
 
-  private LambdasApp() { }
+  private LambdasApp() {
+  }
 
   /**
-   * Program entry point
+   * Program entry point.
    */
   public static void main(final String[] args) {
     Task task = new SimpleTask();
diff --git a/callback/src/main/java/com/iluwatar/callback/SimpleTask.java b/callback/src/main/java/com/iluwatar/callback/SimpleTask.java
@@ -23,14 +23,12 @@
 
 package com.iluwatar.callback;
 
-import org.slf4j.Logger;
-
 import static org.slf4j.LoggerFactory.getLogger;
 
+import org.slf4j.Logger;
+
 /**
- *
- * Implementation of task that need to be executed
- *
+ * Implementation of task that need to be executed.
  */
 public final class SimpleTask extends Task {
 
@@ -39,6 +37,6 @@ public final class SimpleTask extends Task {
   @Override
   public void execute() {
     LOGGER.info("Perform some important activity and after call the"
-            + " callback method.");
+        + " callback method.");
   }
 }
diff --git a/callback/src/main/java/com/iluwatar/callback/Task.java b/callback/src/main/java/com/iluwatar/callback/Task.java
@@ -24,14 +24,12 @@
 package com.iluwatar.callback;
 
 /**
- *
- * Template-method class for callback hook execution
- *
+ * Template-method class for callback hook execution.
  */
 public abstract class Task {
 
   /**
-   * Execute with callback
+   * Execute with callback.
    */
   final void executeWith(final Callback callback) {
     execute();
diff --git a/chain/src/main/java/com/iluwatar/chain/App.java b/chain/src/main/java/com/iluwatar/chain/App.java
@@ -24,23 +24,21 @@
 package com.iluwatar.chain;
 
 /**
- * 
  * The Chain of Responsibility pattern is a design pattern consisting of command objects and a
  * series of processing objects. Each processing object contains logic that defines the types of
  * command objects that it can handle; the rest are passed to the next processing object in the
  * chain. A mechanism also exists for adding new processing objects to the end of this chain.
- * <p>
- * In this example we organize the request handlers ({@link RequestHandler}) into a chain where each
- * handler has a chance to act on the request on its turn. Here the king ({@link OrcKing}) makes
- * requests and the military orcs ({@link OrcCommander}, {@link OrcOfficer}, {@link OrcSoldier})
- * form the handler chain.
- * 
+ *
+ * <p>In this example we organize the request handlers ({@link RequestHandler}) into a chain where
+ * each handler has a chance to act on the request on its turn. Here the king ({@link OrcKing})
+ * makes requests and the military orcs ({@link OrcCommander}, {@link OrcOfficer}, {@link
+ * OrcSoldier}) form the handler chain.
  */
 public class App {
 
   /**
-   * Program entry point
-   * 
+   * Program entry point.
+   *
    * @param args command line args
    */
   public static void main(String[] args) {
diff --git a/chain/src/main/java/com/iluwatar/chain/OrcCommander.java b/chain/src/main/java/com/iluwatar/chain/OrcCommander.java
@@ -24,9 +24,7 @@
 package com.iluwatar.chain;
 
 /**
- * 
- * OrcCommander
- *
+ * OrcCommander.
  */
 public class OrcCommander extends RequestHandler {
 
diff --git a/chain/src/main/java/com/iluwatar/chain/OrcKing.java b/chain/src/main/java/com/iluwatar/chain/OrcKing.java
@@ -24,9 +24,7 @@
 package com.iluwatar.chain;
 
 /**
- * 
  * OrcKing makes requests that are handled by the chain.
- * 
  */
 public class OrcKing {
 
diff --git a/chain/src/main/java/com/iluwatar/chain/OrcOfficer.java b/chain/src/main/java/com/iluwatar/chain/OrcOfficer.java
@@ -24,9 +24,7 @@
 package com.iluwatar.chain;
 
 /**
- * 
- * OrcOfficer
- *
+ * OrcOfficer.
  */
 public class OrcOfficer extends RequestHandler {
 
diff --git a/chain/src/main/java/com/iluwatar/chain/OrcSoldier.java b/chain/src/main/java/com/iluwatar/chain/OrcSoldier.java
@@ -24,9 +24,7 @@
 package com.iluwatar.chain;
 
 /**
- * 
- * OrcSoldier
- *
+ * OrcSoldier.
  */
 public class OrcSoldier extends RequestHandler {
 
diff --git a/chain/src/main/java/com/iluwatar/chain/Request.java b/chain/src/main/java/com/iluwatar/chain/Request.java
@@ -26,24 +26,24 @@
 import java.util.Objects;
 
 /**
- * Request
+ * Request.
  */
 public class Request {
 
   /**
    * The type of this request, used by each item in the chain to see if they should or can handle
-   * this particular request
+   * this particular request.
    */
   private final RequestType requestType;
 
   /**
-   * A description of the request
+   * A description of the request.
    */
   private final String requestDescription;
 
   /**
    * Indicates if the request is handled or not. A request can only switch state from unhandled to
-   * handled, there's no way to 'unhandle' a request
+   * handled, there's no way to 'unhandle' a request.
    */
   private boolean handled;
 
@@ -59,7 +59,7 @@ public Request(final RequestType requestType, final String requestDescription) {
   }
 
   /**
-   * Get a description of the request
+   * Get a description of the request.
    *
    * @return A human readable description of the request
    */
@@ -69,7 +69,7 @@ public String getRequestDescription() {
 
   /**
    * Get the type of this request, used by each person in the chain of command to see if they should
-   * or can handle this particular request
+   * or can handle this particular request.
    *
    * @return The request type
    */
@@ -78,14 +78,14 @@ public RequestType getRequestType() {
   }
 
   /**
-   * Mark the request as handled
+   * Mark the request as handled.
    */
   public void markHandled() {
     this.handled = true;
   }
 
   /**
-   * Indicates if this request is handled or not
+   * Indicates if this request is handled or not.
    *
    * @return <tt>true</tt> when the request is handled, <tt>false</tt> if not
    */
diff --git a/chain/src/main/java/com/iluwatar/chain/RequestHandler.java b/chain/src/main/java/com/iluwatar/chain/RequestHandler.java
@@ -27,9 +27,7 @@
 import org.slf4j.LoggerFactory;
 
 /**
- * 
- * RequestHandler
- *
+ * RequestHandler.
  */
 public abstract class RequestHandler {
 
@@ -42,7 +40,7 @@ public RequestHandler(RequestHandler next) {
   }
 
   /**
-   * Request handler
+   * Request handler.
    */
   public void handleRequest(Request req) {
     if (next != null) {
diff --git a/chain/src/main/java/com/iluwatar/chain/RequestType.java b/chain/src/main/java/com/iluwatar/chain/RequestType.java
@@ -24,9 +24,7 @@
 package com.iluwatar.chain;
 
 /**
- * 
- * RequestType enumeration
- *
+ * RequestType enumeration.
  */
 public enum RequestType {
 
diff --git a/circuit-breaker/src/main/java/com/iluwatar/circuitbreaker/App.java b/circuit-breaker/src/main/java/com/iluwatar/circuitbreaker/App.java
@@ -28,57 +28,54 @@
 
 /**
  * <p>
- * The intention of the Circuit Builder pattern is to handle remote failures 
- * robustly, which is to mean that if a service is dependant on n number of
- * other services, and m of them fail, we should be able to recover from that
- * failure by ensuring that the user can still use the services that are actually
- * functional, and resources are not tied up by uselessly by the services which
- * are not working. However, we should also be able to detect when any of the m
- * failing services become operational again, so that we can use it
+ * The intention of the Circuit Builder pattern is to handle remote failures robustly, which is to
+ * mean that if a service is dependant on n number of other services, and m of them fail, we should
+ * be able to recover from that failure by ensuring that the user can still use the services that
+ * are actually functional, and resources are not tied up by uselessly by the services which are not
+ * working. However, we should also be able to detect when any of the m failing services become
+ * operational again, so that we can use it
  * </p>
  * <p>
- * In this example, the circuit breaker pattern is demonstrated by using two services:
- * {@link MonitoringService} and {@link DelayedService}. The monitoring service
- * is responsible for calling two services: a local service and a remote service {@link DelayedService}
- * , and by using the circuit breaker construction we ensure that if the call to
- * remote service is going to fail, we are going to save our resources and not make the 
- * function call at all, by wrapping our call to the remote service in the circuit
- * breaker object.
+ * In this example, the circuit breaker pattern is demonstrated by using two services: {@link
+ * MonitoringService} and {@link DelayedService}. The monitoring service is responsible for calling
+ * two services: a local service and a remote service {@link DelayedService} , and by using the
+ * circuit breaker construction we ensure that if the call to remote service is going to fail, we
+ * are going to save our resources and not make the function call at all, by wrapping our call to
+ * the remote service in the circuit breaker object.
  * </p>
  * <p>
- * This works as follows: The {@link CircuitBreaker} object can be in one of three
- * states: <b>Open</b>, <b>Closed</b> and <b>Half-Open</b>, which represents the real
- * world circuits. If the state is closed (initial), we assume everything is alright
- * and perform the function call. However, every time the call fails, we note it
- * and once it crosses a threshold, we set the state to Open, preventing any further
- * calls to the remote server. Then, after a certain retry period (during which we
- * expect thee service to recover), we make another call to the remote server and
- * this state is called the Half-Open state, where it stays till the service is down,
- * and once it recovers, it goes back to the closed state and the cycle continues.
+ * This works as follows: The {@link CircuitBreaker} object can be in one of three states:
+ * <b>Open</b>, <b>Closed</b> and <b>Half-Open</b>, which represents the real world circuits. If the
+ * state is closed (initial), we assume everything is alright and perform the function call.
+ * However, every time the call fails, we note it and once it crosses a threshold, we set the state
+ * to Open, preventing any further calls to the remote server. Then, after a certain retry period
+ * (during which we expect thee service to recover), we make another call to the remote server and
+ * this state is called the Half-Open state, where it stays till the service is down, and once it
+ * recovers, it goes back to the closed state and the cycle continues.
  * </p>
  */
 public class App {
-   
+
   private static final Logger LOGGER = LoggerFactory.getLogger(App.class);
-    
-   /**
-   * Program entry point
-   * 
+
+  /**
+   * Program entry point.
+   *
    * @param args command line args
    */
   @SuppressWarnings("squid:S2189")
   public static void main(String[] args) {
     //Create an object of monitoring service which makes both local and remote calls
     var obj = new MonitoringService();
     //Set the circuit Breaker parameters
-    var circuitBreaker = new CircuitBreaker(3000, 1, 2000 * 1000 * 1000); 
+    var circuitBreaker = new CircuitBreaker(3000, 1, 2000 * 1000 * 1000);
     var serverStartTime = System.nanoTime();
     while (true) {
       LOGGER.info(obj.localResourceResponse());
       LOGGER.info(obj.remoteResourceResponse(circuitBreaker, serverStartTime));
       LOGGER.info(circuitBreaker.getState());
       try {
-        Thread.sleep(5 * 1000); 
+        Thread.sleep(5 * 1000);
       } catch (InterruptedException e) {
         LOGGER.error(e.getMessage());
       }
diff --git a/circuit-breaker/src/main/java/com/iluwatar/circuitbreaker/CircuitBreaker.java b/circuit-breaker/src/main/java/com/iluwatar/circuitbreaker/CircuitBreaker.java
diff --git a/circuit-breaker/src/main/java/com/iluwatar/circuitbreaker/DelayedService.java b/circuit-breaker/src/main/java/com/iluwatar/circuitbreaker/DelayedService.java
diff --git a/circuit-breaker/src/main/java/com/iluwatar/circuitbreaker/MonitoringService.java b/circuit-breaker/src/main/java/com/iluwatar/circuitbreaker/MonitoringService.java
diff --git a/circuit-breaker/src/main/java/com/iluwatar/circuitbreaker/State.java b/circuit-breaker/src/main/java/com/iluwatar/circuitbreaker/State.java
