Review fixes

Author: iluwatar

hexagonal/pom.xml

@@ -32,11 +32,7 @@
     <artifactId>java-design-patterns</artifactId>
     <version>1.12.0-SNAPSHOT</version>
   </parent>
-  <groupId>com.iluwatar.hexagonal</groupId>
   <artifactId>hexagonal</artifactId>
-  <version>1.0-SNAPSHOT</version>
-  <name>hexagonal</name>
-  <url>http://maven.apache.org</url>
   <dependencies>
     <dependency>
       <groupId>junit</groupId>

hexagonal/src/main/java/com/iluwatar/hexagonal/administration/LotteryAdministration.java

@@ -35,8 +35,19 @@
  */
 public interface LotteryAdministration {
 
+  /**
+   * Get all the lottery tickets submitted for lottery
+   */
   Map<LotteryTicketId, LotteryTicket> getAllSubmittedTickets();
+
+  /**
+   * Draw lottery numbers
+   */
   LotteryNumbers performLottery();
+
+  /**
+   * Begin new lottery round
+   */
   void resetLottery();
 
 }

hexagonal/src/main/java/com/iluwatar/hexagonal/administration/LotteryAdministrationImpl.java

@@ -47,13 +47,9 @@
 public class LotteryAdministrationImpl implements LotteryAdministration {
 
   private final LotteryTicketRepository repository;
-
   private final LotteryService service = new LotteryServiceImpl();
-  
   private final LotteryNotifications notifications = new LotteryNotificationsImpl();
-
   private final WireTransfers bank = new WireTransfersImpl();
-  
   public LotteryAdministrationImpl() {
     repository = new LotteryTicketInMemoryRepository();
   }

hexagonal/src/main/java/com/iluwatar/hexagonal/banking/WireTransfers.java

@@ -29,8 +29,19 @@
  */
 public interface WireTransfers {
 
+  /**
+   * Set amount of funds for bank account
+   */
   void setFunds(String bankAccount, int amount);
+
+  /**
+   * Get amount of funds for bank account
+   */
   int getFunds(String bankAccount);
+
+  /**
+   * Transfer funds from one bank account to another
+   */
   boolean transferFunds(int amount, String sourceBackAccount, String destinationBankAccount);
 
 }

hexagonal/src/main/java/com/iluwatar/hexagonal/database/LotteryTicketRepository.java

@@ -35,9 +35,24 @@
  */
 public interface LotteryTicketRepository {
 
+  /**
+   * Find lottery ticket by id
+   */
   Optional<LotteryTicket> findById(LotteryTicketId id);
+
+  /**
+   * Save lottery ticket
+   */
   Optional<LotteryTicketId> save(LotteryTicket ticket);
+
+  /**
+   * Get all lottery tickets
+   */
   Map<LotteryTicketId, LotteryTicket> findAll();
+
+  /**
+   * Delete all lottery tickets
+   */
   void deleteAll();
 
 }

hexagonal/src/main/java/com/iluwatar/hexagonal/domain/LotteryTicketCheckResult.java

@@ -32,7 +32,6 @@ public class LotteryTicketCheckResult {
   public enum CheckResult { WIN_PRIZE, NO_PRIZE, TICKET_NOT_SUBMITTED };
 
   private final CheckResult checkResult;
-  
   private final int prizeAmount;
 
   /**

hexagonal/src/main/java/com/iluwatar/hexagonal/domain/LotteryTicketId.java

@@ -24,6 +24,9 @@
 
 import java.util.UUID;
 
+/**
+ * Lottery ticked id
+ */
 public class LotteryTicketId {
 
   private final UUID id;

hexagonal/src/main/java/com/iluwatar/hexagonal/notifications/LotteryNotifications.java

@@ -30,11 +30,30 @@
  *
  */
 public interface LotteryNotifications {
-  
+
+  /**
+   * Notify lottery ticket was submitted
+   */
   void notifyTicketSubmitted(PlayerDetails details);
+
+  /**
+   * Notify there was an error submitting lottery ticket
+   */
   void notifyTicketSubmitError(PlayerDetails details);
+
+  /**
+   * Notify lottery ticket did not win
+   */
   void notifyNoWin(PlayerDetails details);
+
+  /**
+   * Notify that prize has been paid
+   */
   void notifyPrize(PlayerDetails details, int prizeAmount);
+
+  /**
+   * Notify that there was an error paying the prize
+   */
   void notifyPrizeError(PlayerDetails details, int prizeAmount);
 
 }

hexagonal/src/main/java/com/iluwatar/hexagonal/service/LotteryService.java

@@ -36,7 +36,13 @@
  */
 public interface LotteryService {
 
+  /**
+   * Submit lottery ticket to participate in the lottery
+   */
   Optional<LotteryTicketId> submitTicket(LotteryTicket ticket);
 
+  /**
+   * Check if lottery ticket has won
+   */
   LotteryTicketCheckResult checkTicketForPrize(LotteryTicketId id, LotteryNumbers winningNumbers);
 }

hexagonal/src/main/java/com/iluwatar/hexagonal/service/LotteryServiceImpl.java

@@ -49,7 +49,10 @@ public class LotteryServiceImpl implements LotteryService {
   private final WireTransfers bank = new WireTransfersImpl();
 
   private final LotteryNotifications notifications = new LotteryNotificationsImpl();
-  
+
+  /**
+   * Constructor
+   */
   public LotteryServiceImpl() {
     repository = new LotteryTicketInMemoryRepository();
   }