Fixed code to follow coding conventions

adapter/src/main/java/com/iluwatar/adapter/App.java

@@ -1,30 +1,26 @@
 package com.iluwatar.adapter;
 
 /**
- * An adapter helps two incompatible interfaces to work together. This is the
+ * An adapter helps two incompatible interfaces to work together. This is the real world definition
- * real world definition for an adapter. Interfaces may be incompatible but the
+ * for an adapter. Interfaces may be incompatible but the inner functionality should suit the need.
- * inner functionality should suit the need. The Adapter design pattern allows
+ * The Adapter design pattern allows otherwise incompatible classes to work together by converting
- * otherwise incompatible classes to work together by converting the interface
+ * the interface of one class into an interface expected by the clients.
- * of one class into an interface expected by the clients.
  *
  * <p>
- * There are two variations of the Adapter pattern: The class adapter implements
+ * There are two variations of the Adapter pattern: The class adapter implements the adaptee's
- * the adaptee's interface whereas the object adapter uses composition to
+ * interface whereas the object adapter uses composition to contain the adaptee in the adapter
- * contain the adaptee in the adapter object. This example uses the object
+ * object. This example uses the object adapter approach.
- * adapter approach.
  *
  * <p>
- * The Adapter ({@link BattleFishingBoat}) converts the interface of the adaptee
+ * The Adapter ({@link BattleFishingBoat}) converts the interface of the adaptee class (
- * class ( {@link FishingBoat}) into a suitable one expected by the client (
+ * {@link FishingBoat}) into a suitable one expected by the client ( {@link BattleShip} ).
- * {@link BattleShip} ).
  *
  * <p>
  * The story of this implementation is this. <br>
- * Pirates are coming! we need a {@link BattleShip} to fight! We have a
+ * Pirates are coming! we need a {@link BattleShip} to fight! We have a {@link FishingBoat} and our
- * {@link FishingBoat} and our captain. We have no time to make up a new ship!
+ * captain. We have no time to make up a new ship! we need to reuse this {@link FishingBoat}. The
- * we need to reuse this {@link FishingBoat}. The captain needs a battleship
+ * captain needs a battleship which can fire and move. The spec is in {@link BattleShip}. We will
- * which can fire and move. The spec is in {@link BattleShip}. We will use the
+ * use the Adapter pattern to reuse {@link FishingBoat}.
- * Adapter pattern to reuse {@link FishingBoat}.
  *
  */
 public class App {
@@ -32,8 +28,7 @@ public class App {
   /**
    * Program entry point.
    *
-	 * @param args
+   * @param args command line args
-	 *            command line args
    */
   public static void main(String[] args) {
     Captain captain = new Captain(new BattleFishingBoat());

adapter/src/test/java/com/iluwatar/adapter/AdapterPatternTest.java

@@ -15,30 +15,7 @@ import com.iluwatar.adapter.Captain;
 import com.iluwatar.adapter.FishingBoat;
 
 /**
- * An adapter helps two incompatible interfaces to work together. This is the
+ * Test class
- * real world definition for an adapter. Interfaces may be incompatible but the
- * inner functionality should suit the need. The Adapter design pattern allows
- * otherwise incompatible classes to work together by converting the interface
- * of one class into an interface expected by the clients.
- * 
- * <p>
- * There are two variations of the Adapter pattern: The class adapter implements
- * the adaptee's interface whereas the object adapter uses composition to
- * contain the adaptee in the adapter object. This example uses the object
- * adapter approach.
- * 
- * <p>
- * The Adapter ({@link BattleFishingBoat}) converts the interface of the adaptee
- * class ( {@link FishingBoat}) into a suitable one expected by the client (
- * {@link BattleShip} ).
- * 
- * <p>
- * The story of this implementation is this. <br>
- * Pirates are coming! we need a {@link BattleShip} to fight! We have a
- * {@link FishingBoat} and our captain. We have no time to make up a new ship!
- * we need to reuse this {@link FishingBoat}. The captain needs a battleship
- * which can fire and move. The spec is in {@link BattleShip}. We will use the
- * Adapter pattern to reuse {@link FishingBoat} which operates properly
  * 
  */
 public class AdapterPatternTest {
@@ -50,8 +27,7 @@ public class AdapterPatternTest {
   private static final String CAPTAIN_BEAN = "captain";
 
   /**
-	 * This method runs before the test execution and sets the bean objects in
+   * This method runs before the test execution and sets the bean objects in the beans Map.
-	 * the beans Map.
    */
   @Before
   public void setup() {
@@ -66,11 +42,10 @@ public class AdapterPatternTest {
   }
 
   /**
-	 * This test asserts that when we use the move() method on a captain
+   * This test asserts that when we use the move() method on a captain bean(client), it is
-	 * bean(client), it is internally calling move method on the battleship
+   * internally calling move method on the battleship object. The Adapter ({@link BattleFishingBoat}
-	 * object. The Adapter ({@link BattleFishingBoat}) converts the interface of
+   * ) converts the interface of the target class ( {@link FishingBoat}) into a suitable one
-	 * the target class ( {@link FishingBoat}) into a suitable one expected by
+   * expected by the client ({@link Captain} ).
-	 * the client ({@link Captain} ).
    */
   @Test
   public void testAdapter() {