pattern: Active-Object pattern. (#1660)

* Closes #65.

* Removed

* Removed unnecessary files. Added logging. Closes Fixes #1660.

* Added Terminition condition.

* Logger implemented. Removed maven wrapper.

* Added module to parent POM. removed .gitignore

* Replaced tabs with whitespaces, added Javadocs.

* Fixed more whitespaces problems.

* Fixed more checkstyle errors

* More checkstyle errors.

* Checkstyle errors.

* Final checkstyle cleanup

* Added UML file. Changed System.exit() to Runtime.

* Changed buisiness logic and readme.md file

* Changed typos and readme.md file

* Fixed checkstyle errors

* Fixed grammer errors and CircleCI bugs.

* Wrong readme.md

* Added Thread.interrupt() for after catching exception.

* Fixed SonarCloud code smells.

* Removed unused brackets.

* Changed main program exit logic. Added tests.

* Reverted abstract-factory

* Cleaned code

* Added static to loggers. cleaned code smells.

* Checkstyle errors.

* Code Smells.

Co-authored-by: Subhrodip Mohanta <hello@subho.xyz>

active-object/src/main/java/com/iluwatar/activeobject/ActiveCreature.java

@@ -0,0 +1,95 @@
+package com.iluwatar.activeobject;
+
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.LinkedBlockingQueue;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * ActiveCreature class is the base of the active object example.
+ * @author Noam Greenshtain
+ *
+ */
+public abstract class ActiveCreature {
+  
+  private static final Logger logger = LoggerFactory.getLogger(ActiveCreature.class.getName());
+
+  private BlockingQueue<Runnable> requests;
+  
+  private String name;
+  
+  private Thread thread; // Thread of execution.
+  
+  private int status; // status of the thread of execution.
+
+  /**
+   * Constructor and initialization.
+   */
+  protected ActiveCreature(String name) {
+    this.name = name;
+    this.status = 0;
+    this.requests = new LinkedBlockingQueue<>();
+    thread = new Thread(() -> {
+      boolean infinite = true;
+      while (infinite) {
+        try {
+          requests.take().run();
+        } catch (InterruptedException e) {
+          if (this.status != 0) {
+            logger.error("Thread was interrupted. --> {}", e.getMessage()); 
+          }
+          infinite = false;
+          Thread.currentThread().interrupt();
+        }
+      }
+    });
+    thread.start();
+  }
+
+  /**
+   * Eats the porridge.
+   * @throws InterruptedException due to firing a new Runnable.
+   */
+  public void eat() throws InterruptedException {
+    requests.put(() -> {
+      logger.info("{} is eating!",name());
+      logger.info("{} has finished eating!",name());
+    });
+  }
+
+  /**
+   * Roam in the wastelands.
+   * @throws InterruptedException due to firing a new Runnable.
+   */
+  public void roam() throws InterruptedException {
+    requests.put(() ->
+        logger.info("{} has started to roam in the wastelands.",name())
+    );
+  }
+  
+  /**
+   * Returns the name of the creature.
+   * @return the name of the creature.
+   */
+  public String name() {
+    return this.name;
+  }
+  
+  /**
+   * Kills the thread of execution.
+   * @param status of the thread of execution. 0 == OK, the rest is logging an error.
+   */
+  public void kill(int status) {
+    this.status = status;
+    this.thread.interrupt();
+  }
+  
+  /**
+   * Returns the status of the thread of execution.
+   * @return the status of the thread of execution.
+   */
+  public int getStatus() {
+    return this.status;
+  }
+}

active-object/src/main/java/com/iluwatar/activeobject/App.java

@@ -0,0 +1,75 @@
+/*
+ * The MIT License
+ * Copyright © 2014-2021 Ilkka Seppälä
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package com.iluwatar.activeobject;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * The Active Object pattern helps to solve synchronization difficulties without using 
+ * 'synchronized' methods. The active object will contain a thread-safe data structure 
+ * (such as BlockingQueue) and use to synchronize method calls by moving the logic of the method
+ * into an invocator(usually a Runnable) and store it in the DSA.
+ * 
+ * <p>In this example, we fire 20 threads to modify a value in the target class.
+ */
+public class App implements Runnable {
+  
+  private static final Logger logger = LoggerFactory.getLogger(App.class.getName());
+  
+  private static final int NUM_CREATURES = 3;
+
+  /**
+   * Program entry point.
+   *
+   * @param args command line arguments.
+   */
+  public static void main(String[] args) {  
+    var app = new App();
+    app.run();
+  }
+  
+  @Override
+  public void run() {
+    List<ActiveCreature> creatures = new ArrayList<>();
+    try {
+      for (int i = 0;i < NUM_CREATURES;i++) {
+        creatures.add(new Orc(Orc.class.getSimpleName() + i));
+        creatures.get(i).eat();
+        creatures.get(i).roam();
+      }
+      Thread.sleep(1000);
+    } catch (InterruptedException e) {
+      logger.error(e.getMessage());
+      Thread.currentThread().interrupt();
+    } finally {
+      for (int i = 0;i < NUM_CREATURES;i++) {
+        creatures.get(i).kill(0);
+      }
+    }
+  }
+}

active-object/src/main/java/com/iluwatar/activeobject/Orc.java

@@ -0,0 +1,14 @@
+package com.iluwatar.activeobject;
+
+/**
+ * An implementation of the ActiveCreature class.
+ * @author Noam Greenshtain
+ *
+ */
+public class Orc extends ActiveCreature {
+
+  public Orc(String name) {
+    super(name);
+  }
+
+}