Merge remote-tracking branch 'upstream/master' into data-bus

* upstream/master: (67 commits)
  Set version for next development iteration
  Reached milestone 1.15.0
  iluwatar#539 Checkstyle fix
  iluwatar#539 More Checkstyle fixes
  iluwatar#539 Checkstyle fixes
  iluwatar#497 Add missing puml and license headers
  iluwatar#77 Add missing license header
  Work on iluwatar#190: urm/puml updates * added pumlid where it was missing and possible * removed pumlid where it generated a bad image * regenerated some incorrect puml's * added 'left to right direction' puml prefix to some diagrams to improve the automatic layouting
  Removed AvoidStarImport Rule Added JavaDocType Rule
  Update App.java
  Update App.java
  Update after changes from review. Additional improvements.
  Pom.xml files fixed.
  iluwatar#66 Balking Pattern
  fixed pmd violation
  fixed checkstyle violations
  diagrams added
  comments, tests and description
  changed parent POM version iluwatar#69
  apply changes from review iluwatar#69
  ...

# Conflicts:
#	pom.xml

Author: kemitix

abstract-document/pom.xml

@@ -29,7 +29,7 @@
     <parent>
         <artifactId>java-design-patterns</artifactId>
         <groupId>com.iluwatar</groupId>
-        <version>1.15.0-SNAPSHOT</version>
+        <version>1.16.0-SNAPSHOT</version>
     </parent>
     <artifactId>abstract-document</artifactId>
     <dependencies>

abstract-factory/pom.xml

@@ -29,7 +29,7 @@
   <parent>
     <groupId>com.iluwatar</groupId>
     <artifactId>java-design-patterns</artifactId>
-    <version>1.15.0-SNAPSHOT</version>
+    <version>1.16.0-SNAPSHOT</version>
   </parent>
   <artifactId>abstract-factory</artifactId>
   <dependencies>

abstract-factory/src/test/java/com/iluwatar/abstractfactory/AbstractFactoryTest.java

@@ -28,6 +28,9 @@
 import org.junit.Before;
 import org.junit.Test;
 
+/**
+ * Test for abstract factory
+ */
 public class AbstractFactoryTest {
 
   private App app = new App();

adapter/pom.xml

@@ -29,7 +29,7 @@
   <parent>
     <groupId>com.iluwatar</groupId>
     <artifactId>java-design-patterns</artifactId>
-    <version>1.15.0-SNAPSHOT</version>
+    <version>1.16.0-SNAPSHOT</version>
   </parent>
   <artifactId>adapter</artifactId>
   <dependencies>

aggregator-microservices/aggregator-service/pom.xml

@@ -29,7 +29,7 @@
     <parent>
         <artifactId>aggregator-microservices</artifactId>
         <groupId>com.iluwatar</groupId>
-        <version>1.15.0-SNAPSHOT</version>
+        <version>1.16.0-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

aggregator-microservices/aggregator-service/src/main/java/com/iluwatar/aggregator/microservices/App.java

@@ -25,6 +25,9 @@
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
+/**
+ * Spring Boot EntryPoint Class
+ */
 @SpringBootApplication
 public class App {
 

aggregator-microservices/aggregator-service/src/test/java/com/iluwatar/aggregator/microservices/AggregatorTest.java

@@ -22,15 +22,18 @@
  */
 package com.iluwatar.aggregator.microservices;
 
+import static org.junit.Assert.assertEquals;
+import static org.mockito.Mockito.when;
+
 import org.junit.Before;
 import org.junit.Test;
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
 
-import static org.junit.Assert.assertEquals;
-import static org.mockito.Mockito.when;
-
+/**
+ * Test Aggregation of domain objects
+ */
 public class AggregatorTest {
 
   @InjectMocks
@@ -64,4 +67,4 @@ public void testGetProduct() {
     assertEquals(inventories, testProduct.getProductInventories());
   }
 
-}
+}

aggregator-microservices/information-microservice/pom.xml

@@ -29,7 +29,7 @@
     <parent>
         <artifactId>aggregator-microservices</artifactId>
         <groupId>com.iluwatar</groupId>
-        <version>1.15.0-SNAPSHOT</version>
+        <version>1.16.0-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

aggregator-microservices/information-microservice/src/main/java/com/iluwatar/information/microservice/InformationController.java

@@ -26,6 +26,9 @@
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.RestController;
 
+/**
+ * Controller providing endpoints to retrieve information about products
+ */
 @RestController
 public class InformationController {
 

aggregator-microservices/information-microservice/src/test/java/com/iluwatar/information/microservice/InformationControllerTest.java

@@ -25,6 +25,9 @@
 import org.junit.Assert;
 import org.junit.Test;
 
+/**
+ * Test for Information Rest Controller
+ */
 public class InformationControllerTest {
 
   @Test
@@ -36,4 +39,4 @@ public void shouldGetProductTitle() {
     Assert.assertEquals("The Product Title.", title);
   }
 
-}
+}

aggregator-microservices/inventory-microservice/pom.xml

@@ -29,7 +29,7 @@
     <parent>
         <artifactId>aggregator-microservices</artifactId>
         <groupId>com.iluwatar</groupId>
-        <version>1.15.0-SNAPSHOT</version>
+        <version>1.16.0-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

aggregator-microservices/inventory-microservice/src/main/java/com/iluwatar/inventory/microservice/InventoryController.java

@@ -26,6 +26,9 @@
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.RestController;
 
+/**
+ * Controller providing endpoints to retrieve product inventories
+ */
 @RestController
 public class InventoryController {
 

aggregator-microservices/inventory-microservice/src/test/java/com/iluwatar/inventory/microservice/InventoryControllerTest.java

@@ -25,8 +25,10 @@
 import org.junit.Assert;
 import org.junit.Test;
 
+/**
+ * Test Inventory Rest Controller
+ */
 public class InventoryControllerTest {
-
   @Test
   public void testGetProductInventories() throws Exception {
     InventoryController inventoryController = new InventoryController();
@@ -35,4 +37,4 @@ public void testGetProductInventories() throws Exception {
 
     Assert.assertEquals(5, numberOfInventories);
   }
-}
+}

aggregator-microservices/pom.xml

@@ -29,7 +29,7 @@
     <parent>
         <artifactId>java-design-patterns</artifactId>
         <groupId>com.iluwatar</groupId>
-        <version>1.15.0-SNAPSHOT</version>
+        <version>1.16.0-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>aggregator-microservices</artifactId>

api-gateway/api-gateway-service/pom.xml

@@ -29,7 +29,7 @@
   <parent>
     <artifactId>api-gateway</artifactId>
     <groupId>com.iluwatar</groupId>
-    <version>1.15.0-SNAPSHOT</version>
+    <version>1.16.0-SNAPSHOT</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
   <artifactId>api-gateway-service</artifactId>

api-gateway/api-gateway-service/src/main/java/com/iluwatar/api/gateway/ImageClientImpl.java

@@ -35,7 +35,7 @@
  * An adapter to communicate with the Image microservice
  */
 @Component
-public class ImageClientImpl implements ImageClient{
+public class ImageClientImpl implements ImageClient {
   /**
    * Makes a simple HTTP Get request to the Image microservice
    * @return The path to the image

api-gateway/api-gateway-service/src/main/java/com/iluwatar/api/gateway/PriceClientImpl.java

@@ -35,7 +35,7 @@
  * An adapter to communicate with the Price microservice
  */
 @Component
-public class PriceClientImpl implements PriceClient{
+public class PriceClientImpl implements PriceClient {
   /**
    * Makes a simple HTTP Get request to the Price microservice
    * @return The price of the product

api-gateway/api-gateway-service/src/test/java/com/iluwatar/api/gateway/ApiGatewayTest.java

@@ -22,15 +22,18 @@
  */
 package com.iluwatar.api.gateway;
 
+import static org.junit.Assert.assertEquals;
+import static org.mockito.Mockito.when;
+
 import org.junit.Before;
 import org.junit.Test;
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
 
-import static org.junit.Assert.assertEquals;
-import static org.mockito.Mockito.when;
-
+/**
+ * Test API Gateway Pattern
+ */
 public class ApiGatewayTest {
 
   @InjectMocks

api-gateway/image-microservice/pom.xml

@@ -29,7 +29,7 @@
   <parent>
     <artifactId>api-gateway</artifactId>
     <groupId>com.iluwatar</groupId>
-    <version>1.15.0-SNAPSHOT</version>
+    <version>1.16.0-SNAPSHOT</version>
   </parent>
 
   <modelVersion>4.0.0</modelVersion>

api-gateway/image-microservice/src/test/java/com/iluwatar/image/microservice/ImageControllerTest.java

@@ -25,6 +25,9 @@
 import org.junit.Assert;
 import org.junit.Test;
 
+/**
+ * Test for Image Rest Controller
+ */
 public class ImageControllerTest {
   @Test
   public void testGetImagePath() {

api-gateway/pom.xml

@@ -29,7 +29,7 @@
   <parent>
     <artifactId>java-design-patterns</artifactId>
     <groupId>com.iluwatar</groupId>
-    <version>1.15.0-SNAPSHOT</version>
+    <version>1.16.0-SNAPSHOT</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
   <artifactId>api-gateway</artifactId>

api-gateway/price-microservice/pom.xml

@@ -29,7 +29,7 @@
   <parent>
     <artifactId>api-gateway</artifactId>
     <groupId>com.iluwatar</groupId>
-    <version>1.15.0-SNAPSHOT</version>
+    <version>1.16.0-SNAPSHOT</version>
   </parent>
 
   <modelVersion>4.0.0</modelVersion>

api-gateway/price-microservice/src/test/java/com/iluwatar/price/microservice/PriceControllerTest.java

@@ -25,6 +25,10 @@
 import org.junit.Assert;
 import org.junit.Test;
 
+
+/**
+ * Test for Price Rest Controller
+ */
 public class PriceControllerTest {
   @Test
   public void testgetPrice() {

async-method-invocation/pom.xml

@@ -29,7 +29,7 @@
   <parent>
     <groupId>com.iluwatar</groupId>
     <artifactId>java-design-patterns</artifactId>
-    <version>1.15.0-SNAPSHOT</version>
+    <version>1.16.0-SNAPSHOT</version>
   </parent>
   <artifactId>async-method-invocation</artifactId>
   <dependencies>

async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/AsyncResult.java

@@ -25,8 +25,8 @@
 import java.util.concurrent.ExecutionException;
 
 /**
- * 
  * AsyncResult interface
+ * @param <T> parameter returned when getValue is invoked
  */
 public interface AsyncResult<T> {
 

balking/README.md

@@ -0,0 +1,27 @@
+---
+layout: pattern
+title: Balking
+folder: balking
+permalink: /patterns/balking/
+categories: Concurrency
+tags:
+ - Java
+ - Difficulty-Beginner
+---
+
+## Intent
+Balking Pattern is used to prevent an object from executing certain code if it is an
+incomplete or inappropriate state
+
+![alt text](./etc/balking.png "Balking")
+
+## Applicability
+Use the Balking pattern when
+
+*you want to invoke an action on an object only when it is in a particular state
+*objects are generally only in a state that is prone to balking temporarily
+but for an unknown amount of time
+
+## Related patterns
+* Guarded Suspendion Pattern
+* Double Checked Locking Pattern

balking/etc/balking.png

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<class-diagram version="1.1.13" icons="true" automaticImage="PNG" always-add-relationships="false" 
+  generalizations="true" realizations="true" associations="true" dependencies="false" nesting-relationships="true" 
+  router="FAN">  
+  <class id="1" language="java" name="com.iluwatar.balking.App" project="balking" 
+    file="/balking/src/main/java/com/iluwatar/balking/App.java" binary="false" corner="BOTTOM_RIGHT">    
+    <position height="113" width="114" x="135" y="103"/>    
+    <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+      sort-features="false" accessors="true" visibility="true">      
+      <attributes public="true" package="true" protected="true" private="true" static="true"/>      
+      <operations public="true" package="true" protected="true" private="true" static="true"/>    
+    </display>  
+  </class>  
+  <class id="2" language="java" name="com.iluwatar.balking.WashingMachine" project="balking" 
+    file="/balking/src/main/java/com/iluwatar/balking/WashingMachine.java" binary="false" corner="BOTTOM_RIGHT">    
+    <position height="149" width="268" x="289" y="103"/>    
+    <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+      sort-features="false" accessors="true" visibility="true">      
+      <attributes public="true" package="true" protected="true" private="true" static="true"/>      
+      <operations public="true" package="true" protected="true" private="true" static="true"/>    
+    </display>  
+  </class>  
+  <enumeration id="3" language="java" name="com.iluwatar.balking.WashingMachineState" project="balking" 
+    file="/balking/src/main/java/com/iluwatar/balking/WashingMachineState.java" binary="false" corner="BOTTOM_RIGHT">    
+    <position height="113" width="192" x="289" y="292"/>    
+    <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+      sort-features="false" accessors="true" visibility="true">      
+      <attributes public="true" package="true" protected="true" private="true" static="true"/>      
+      <operations public="true" package="true" protected="true" private="true" static="true"/>    
+    </display>  
+  </enumeration>  
+  <association id="4">    
+    <end type="SOURCE" refId="2" navigable="false">      
+      <attribute id="5" name="washingMachineState"/>      
+      <multiplicity id="6" minimum="0" maximum="1"/>    
+    </end>    
+    <end type="TARGET" refId="3" navigable="true"/>    
+    <display labels="true" multiplicity="true"/>  
+  </association>  
+  <classifier-display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+    sort-features="false" accessors="true" visibility="true">    
+    <attributes public="true" package="true" protected="true" private="true" static="true"/>    
+    <operations public="true" package="true" protected="true" private="true" static="true"/>  
+  </classifier-display>  
+  <association-display labels="true" multiplicity="true"/>
+</class-diagram>

balking/etc/balking.ucls

@@ -0,0 +1,24 @@
+@startuml
+package com.iluwatar.balking {
+  class App {
+    - LOGGER : Logger {static}
+    + App()
+    + main(args : String[]) {static}
+  }
+  class WashingMachine {
+    - LOGGER : Logger {static}
+    - washingMachineState : WashingMachineState
+    + WashingMachine()
+    + endOfWashing()
+    + getWashingMachineState() : WashingMachineState
+    + wash()
+  }
+  enum WashingMachineState {
+    + ENABLED {static}
+    + WASHING {static}
+    + valueOf(name : String) : WashingMachineState {static}
+    + values() : WashingMachineState[] {static}
+  }
+}
+WashingMachine -->  "-washingMachineState" WashingMachineState
+@enduml