improvement: fix issue 1968 and correct visitor pattern code and test. (iluwatar#2023)

xyllq999 · web-flow · commit a568656036a1 · 2022-09-25T21:02:08.000+03:00
* fix issue 1968 and correct visitor pattern code and test.

* fix README code as well.
diff --git a/visitor/README.md b/visitor/README.md
@@ -72,7 +72,7 @@ public class Commander extends Unit {
 
   @Override
   public void accept(UnitVisitor visitor) {
-    visitor.visitCommander(this);
+    visitor.visit(this);
     super.accept(visitor);
   }
 
@@ -90,7 +90,7 @@ public class Sergeant extends Unit {
 
   @Override
   public void accept(UnitVisitor visitor) {
-    visitor.visitSergeant(this);
+    visitor.visit(this);
     super.accept(visitor);
   }
 
@@ -108,7 +108,7 @@ public class Soldier extends Unit {
 
   @Override
   public void accept(UnitVisitor visitor) {
-    visitor.visitSoldier(this);
+    visitor.visit(this);
     super.accept(visitor);
   }
 
@@ -126,17 +126,17 @@ Here are then some concrete visitors.
 public class CommanderVisitor implements UnitVisitor {
 
   @Override
-  public void visitSoldier(Soldier soldier) {
+  public void visit(Soldier soldier) {
     // Do nothing
   }
 
   @Override
-  public void visitSergeant(Sergeant sergeant) {
+  public void visit(Sergeant sergeant) {
     // Do nothing
   }
 
   @Override
-  public void visitCommander(Commander commander) {
+  public void visit(Commander commander) {
     LOGGER.info("Good to see you {}", commander);
   }
 }
@@ -145,17 +145,17 @@ public class CommanderVisitor implements UnitVisitor {
 public class SergeantVisitor implements UnitVisitor {
 
   @Override
-  public void visitSoldier(Soldier soldier) {
+  public void visit(Soldier soldier) {
     // Do nothing
   }
 
   @Override
-  public void visitSergeant(Sergeant sergeant) {
+  public void visit(Sergeant sergeant) {
     LOGGER.info("Hello {}", sergeant);
   }
 
   @Override
-  public void visitCommander(Commander commander) {
+  public void visit(Commander commander) {
     // Do nothing
   }
 }
@@ -164,17 +164,17 @@ public class SergeantVisitor implements UnitVisitor {
 public class SoldierVisitor implements UnitVisitor {
 
   @Override
-  public void visitSoldier(Soldier soldier) {
+  public void visit(Soldier soldier) {
     LOGGER.info("Greetings {}", soldier);
   }
 
   @Override
-  public void visitSergeant(Sergeant sergeant) {
+  public void visit(Sergeant sergeant) {
     // Do nothing
   }
 
   @Override
-  public void visitCommander(Commander commander) {
+  public void visit(Commander commander) {
     // Do nothing
   }
 }
diff --git a/visitor/src/main/java/com/iluwatar/visitor/Commander.java b/visitor/src/main/java/com/iluwatar/visitor/Commander.java
@@ -33,9 +33,13 @@ public Commander(Unit... children) {
     super(children);
   }
 
+  /**
+   * Accept a Visitor.
+   * @param visitor UnitVisitor to be accepted
+   */
   @Override
   public void accept(UnitVisitor visitor) {
-    visitor.visitCommander(this);
+    visitor.visit(this);
     super.accept(visitor);
   }
 
diff --git a/visitor/src/main/java/com/iluwatar/visitor/CommanderVisitor.java b/visitor/src/main/java/com/iluwatar/visitor/CommanderVisitor.java
@@ -32,18 +32,30 @@
 @Slf4j
 public class CommanderVisitor implements UnitVisitor {
 
+  /**
+   * Soldier Visitor method.
+   * @param soldier Soldier to be visited
+   */
   @Override
-  public void visitSoldier(Soldier soldier) {
+  public void visit(Soldier soldier) {
     // Do nothing
   }
 
+  /**
+   * Sergeant Visitor method.
+   * @param sergeant Sergeant to be visited
+   */
   @Override
-  public void visitSergeant(Sergeant sergeant) {
+  public void visit(Sergeant sergeant) {
     // Do nothing
   }
 
+  /**
+   * Commander Visitor method.
+   * @param commander Commander to be visited
+   */
   @Override
-  public void visitCommander(Commander commander) {
+  public void visit(Commander commander) {
     LOGGER.info("Good to see you {}", commander);
   }
 }
diff --git a/visitor/src/main/java/com/iluwatar/visitor/Sergeant.java b/visitor/src/main/java/com/iluwatar/visitor/Sergeant.java
@@ -33,9 +33,13 @@ public Sergeant(Unit... children) {
     super(children);
   }
 
+  /**
+   * Accept a Visitor.
+   * @param visitor UnitVisitor to be accepted
+   */
   @Override
   public void accept(UnitVisitor visitor) {
-    visitor.visitSergeant(this);
+    visitor.visit(this);
     super.accept(visitor);
   }
 
diff --git a/visitor/src/main/java/com/iluwatar/visitor/SergeantVisitor.java b/visitor/src/main/java/com/iluwatar/visitor/SergeantVisitor.java
@@ -32,18 +32,30 @@
 @Slf4j
 public class SergeantVisitor implements UnitVisitor {
 
+  /**
+   * Soldier Visitor method.
+   * @param soldier Soldier to be visited
+   */
   @Override
-  public void visitSoldier(Soldier soldier) {
+  public void visit(Soldier soldier) {
     // Do nothing
   }
 
+  /**
+   * Sergeant Visitor method.
+   * @param sergeant Sergeant to be visited
+   */
   @Override
-  public void visitSergeant(Sergeant sergeant) {
+  public void visit(Sergeant sergeant) {
     LOGGER.info("Hello {}", sergeant);
   }
 
+  /**
+   * Commander Visitor method.
+   * @param commander Commander to be visited
+   */
   @Override
-  public void visitCommander(Commander commander) {
+  public void visit(Commander commander) {
     // Do nothing
   }
 }
diff --git a/visitor/src/main/java/com/iluwatar/visitor/Soldier.java b/visitor/src/main/java/com/iluwatar/visitor/Soldier.java
@@ -33,9 +33,13 @@ public Soldier(Unit... children) {
     super(children);
   }
 
+  /**
+   * Accept a Visitor.
+   * @param visitor UnitVisitor to be accepted
+   */
   @Override
   public void accept(UnitVisitor visitor) {
-    visitor.visitSoldier(this);
+    visitor.visit(this);
     super.accept(visitor);
   }
 
diff --git a/visitor/src/main/java/com/iluwatar/visitor/SoldierVisitor.java b/visitor/src/main/java/com/iluwatar/visitor/SoldierVisitor.java
@@ -32,18 +32,30 @@
 @Slf4j
 public class SoldierVisitor implements UnitVisitor {
 
+  /**
+   * Soldier Visitor method.
+   * @param soldier Soldier to be visited
+   */
   @Override
-  public void visitSoldier(Soldier soldier) {
+  public void visit(Soldier soldier) {
     LOGGER.info("Greetings {}", soldier);
   }
 
+  /**
+   * Sergeant Visitor method.
+   * @param sergeant Sergeant to be visited
+   */
   @Override
-  public void visitSergeant(Sergeant sergeant) {
+  public void visit(Sergeant sergeant) {
     // Do nothing
   }
 
+  /**
+   * Commander Visitor method.
+   * @param commander Commander to be visited
+   */
   @Override
-  public void visitCommander(Commander commander) {
+  public void visit(Commander commander) {
     // Do nothing
   }
 }
diff --git a/visitor/src/main/java/com/iluwatar/visitor/UnitVisitor.java b/visitor/src/main/java/com/iluwatar/visitor/UnitVisitor.java
@@ -29,10 +29,10 @@
  */
 public interface UnitVisitor {
 
-  void visitSoldier(Soldier soldier);
+  void visit(Soldier soldier);
 
-  void visitSergeant(Sergeant sergeant);
+  void visit(Sergeant sergeant);
 
-  void visitCommander(Commander commander);
+  void visit(Commander commander);
 
 }
diff --git a/visitor/src/test/java/com/iluwatar/visitor/CommanderTest.java b/visitor/src/test/java/com/iluwatar/visitor/CommanderTest.java
@@ -43,7 +43,7 @@ public CommanderTest() {
 
   @Override
   void verifyVisit(Commander unit, UnitVisitor mockedVisitor) {
-    verify(mockedVisitor).visitCommander(eq(unit));
+    verify(mockedVisitor).visit(eq(unit));
   }
 
 }
diff --git a/visitor/src/test/java/com/iluwatar/visitor/SergeantTest.java b/visitor/src/test/java/com/iluwatar/visitor/SergeantTest.java
@@ -43,7 +43,7 @@ public SergeantTest() {
 
   @Override
   void verifyVisit(Sergeant unit, UnitVisitor mockedVisitor) {
-    verify(mockedVisitor).visitSergeant(eq(unit));
+    verify(mockedVisitor).visit(eq(unit));
   }
 
 }
diff --git a/visitor/src/test/java/com/iluwatar/visitor/SoldierTest.java b/visitor/src/test/java/com/iluwatar/visitor/SoldierTest.java
@@ -43,7 +43,7 @@ public SoldierTest() {
 
   @Override
   void verifyVisit(Soldier unit, UnitVisitor mockedVisitor) {
-    verify(mockedVisitor).visitSoldier(eq(unit));
+    verify(mockedVisitor).visit(eq(unit));
   }
 
 }
diff --git a/visitor/src/test/java/com/iluwatar/visitor/VisitorTest.java b/visitor/src/test/java/com/iluwatar/visitor/VisitorTest.java
@@ -98,7 +98,7 @@ public VisitorTest(
 
   @Test
   void testVisitCommander() {
-    this.visitor.visitCommander(new Commander());
+    this.visitor.visit(new Commander());
     if (this.commanderResponse.isPresent()) {
       assertEquals(this.commanderResponse.get(), appender.getLastMessage());
       assertEquals(1, appender.getLogSize());
@@ -107,7 +107,7 @@ void testVisitCommander() {
 
   @Test
   void testVisitSergeant() {
-    this.visitor.visitSergeant(new Sergeant());
+    this.visitor.visit(new Sergeant());
     if (this.sergeantResponse.isPresent()) {
       assertEquals(this.sergeantResponse.get(), appender.getLastMessage());
       assertEquals(1, appender.getLogSize());
@@ -116,7 +116,7 @@ void testVisitSergeant() {
 
   @Test
   void testVisitSoldier() {
-    this.visitor.visitSoldier(new Soldier());
+    this.visitor.visit(new Soldier());
     if (this.soldierResponse.isPresent()) {
       assertEquals(this.soldierResponse.get(), appender.getLastMessage());
       assertEquals(1, appender.getLogSize());

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public class Commander extends Unit {`
`72`	`72`
`73`	`73`	`@Override`
`74`	`74`	`public void accept(UnitVisitor visitor) {`
`75`		`- visitor.visitCommander(this);`
	`75`	`+ visitor.visit(this);`
`76`	`76`	`super.accept(visitor);`
`77`	`77`	`}`
`78`	`78`
`@@ -90,7 +90,7 @@ public class Sergeant extends Unit {`
`90`	`90`
`91`	`91`	`@Override`
`92`	`92`	`public void accept(UnitVisitor visitor) {`
`93`		`- visitor.visitSergeant(this);`
	`93`	`+ visitor.visit(this);`
`94`	`94`	`super.accept(visitor);`
`95`	`95`	`}`
`96`	`96`
`@@ -108,7 +108,7 @@ public class Soldier extends Unit {`
`108`	`108`
`109`	`109`	`@Override`
`110`	`110`	`public void accept(UnitVisitor visitor) {`
`111`		`- visitor.visitSoldier(this);`
	`111`	`+ visitor.visit(this);`
`112`	`112`	`super.accept(visitor);`
`113`	`113`	`}`
`114`	`114`
`@@ -126,17 +126,17 @@ Here are then some concrete visitors.`
`126`	`126`	`public class CommanderVisitor implements UnitVisitor {`
`127`	`127`
`128`	`128`	`@Override`
`129`		`- public void visitSoldier(Soldier soldier) {`
	`129`	`+ public void visit(Soldier soldier) {`
`130`	`130`	`// Do nothing`
`131`	`131`	`}`
`132`	`132`
`133`	`133`	`@Override`
`134`		`- public void visitSergeant(Sergeant sergeant) {`
	`134`	`+ public void visit(Sergeant sergeant) {`
`135`	`135`	`// Do nothing`
`136`	`136`	`}`
`137`	`137`
`138`	`138`	`@Override`
`139`		`- public void visitCommander(Commander commander) {`
	`139`	`+ public void visit(Commander commander) {`
`140`	`140`	`LOGGER.info("Good to see you {}", commander);`
`141`	`141`	`}`
`142`	`142`	`}`
`@@ -145,17 +145,17 @@ public class CommanderVisitor implements UnitVisitor {`
`145`	`145`	`public class SergeantVisitor implements UnitVisitor {`
`146`	`146`
`147`	`147`	`@Override`
`148`		`- public void visitSoldier(Soldier soldier) {`
	`148`	`+ public void visit(Soldier soldier) {`
`149`	`149`	`// Do nothing`
`150`	`150`	`}`
`151`	`151`
`152`	`152`	`@Override`
`153`		`- public void visitSergeant(Sergeant sergeant) {`
	`153`	`+ public void visit(Sergeant sergeant) {`
`154`	`154`	`LOGGER.info("Hello {}", sergeant);`
`155`	`155`	`}`
`156`	`156`
`157`	`157`	`@Override`
`158`		`- public void visitCommander(Commander commander) {`
	`158`	`+ public void visit(Commander commander) {`
`159`	`159`	`// Do nothing`
`160`	`160`	`}`
`161`	`161`	`}`
`@@ -164,17 +164,17 @@ public class SergeantVisitor implements UnitVisitor {`
`164`	`164`	`public class SoldierVisitor implements UnitVisitor {`
`165`	`165`
`166`	`166`	`@Override`
`167`		`- public void visitSoldier(Soldier soldier) {`
	`167`	`+ public void visit(Soldier soldier) {`
`168`	`168`	`LOGGER.info("Greetings {}", soldier);`
`169`	`169`	`}`
`170`	`170`
`171`	`171`	`@Override`
`172`		`- public void visitSergeant(Sergeant sergeant) {`
	`172`	`+ public void visit(Sergeant sergeant) {`
`173`	`173`	`// Do nothing`
`174`	`174`	`}`
`175`	`175`
`176`	`176`	`@Override`
`177`		`- public void visitCommander(Commander commander) {`
	`177`	`+ public void visit(Commander commander) {`
`178`	`178`	`// Do nothing`
`179`	`179`	`}`
`180`	`180`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,9 +33,13 @@ public Commander(Unit... children) {`
`33`	`33`	`super(children);`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ /**`
	`37`	`+ * Accept a Visitor.`
	`38`	`+ * @param visitor UnitVisitor to be accepted`
	`39`	`+ */`
`36`	`40`	`@Override`
`37`	`41`	`public void accept(UnitVisitor visitor) {`
`38`		`- visitor.visitCommander(this);`
	`42`	`+ visitor.visit(this);`
`39`	`43`	`super.accept(visitor);`
`40`	`44`	`}`
`41`	`45`
Original file line number	Diff line number	Diff line change
`@@ -33,9 +33,13 @@ public Sergeant(Unit... children) {`
`33`	`33`	`super(children);`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ /**`
	`37`	`+ * Accept a Visitor.`
	`38`	`+ * @param visitor UnitVisitor to be accepted`
	`39`	`+ */`
`36`	`40`	`@Override`
`37`	`41`	`public void accept(UnitVisitor visitor) {`
`38`		`- visitor.visitSergeant(this);`
	`42`	`+ visitor.visit(this);`
`39`	`43`	`super.accept(visitor);`
`40`	`44`	`}`
`41`	`45`
Original file line number	Diff line number	Diff line change
`@@ -33,9 +33,13 @@ public Soldier(Unit... children) {`
`33`	`33`	`super(children);`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ /**`
	`37`	`+ * Accept a Visitor.`
	`38`	`+ * @param visitor UnitVisitor to be accepted`
	`39`	`+ */`
`36`	`40`	`@Override`
`37`	`41`	`public void accept(UnitVisitor visitor) {`
`38`		`- visitor.visitSoldier(this);`
	`42`	`+ visitor.visit(this);`
`39`	`43`	`super.accept(visitor);`
`40`	`44`	`}`
`41`	`45`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public CommanderTest() {`
`43`	`43`
`44`	`44`	`@Override`
`45`	`45`	`void verifyVisit(Commander unit, UnitVisitor mockedVisitor) {`
`46`		`- verify(mockedVisitor).visitCommander(eq(unit));`
	`46`	`+ verify(mockedVisitor).visit(eq(unit));`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public SergeantTest() {`
`43`	`43`
`44`	`44`	`@Override`
`45`	`45`	`void verifyVisit(Sergeant unit, UnitVisitor mockedVisitor) {`
`46`		`- verify(mockedVisitor).visitSergeant(eq(unit));`
	`46`	`+ verify(mockedVisitor).visit(eq(unit));`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`}`