Add logging for undo/redo commands

jiewei98 · Apr 10, 2022 · 9f396da · 9f396da
1 parent 17b288f
commit 9f396da
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 1 deletion.
diff --git a/src/main/java/seedu/address/logic/commands/RedoCommand.java b/src/main/java/seedu/address/logic/commands/RedoCommand.java
@@ -2,6 +2,9 @@
 
 import static java.util.Objects.requireNonNull;
 
+import java.util.logging.Logger;
+
+import seedu.address.commons.core.LogsCenter;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 
@@ -14,11 +17,13 @@ public class RedoCommand extends Command {
 
     public static final String MESSAGE_SUCCESS = "Command redone";
 
+    private final Logger logger = LogsCenter.getLogger(RedoCommand.class);
 
     @Override
     public CommandResult execute(Model model) throws CommandException {
         requireNonNull(model);
         model.redoCommand();
+        logger.info("AddressBook successfully redone");
         return new CommandResult(MESSAGE_SUCCESS);
     }
 }
diff --git a/src/main/java/seedu/address/logic/commands/UndoCommand.java b/src/main/java/seedu/address/logic/commands/UndoCommand.java
@@ -2,6 +2,9 @@
 
 import static java.util.Objects.requireNonNull;
 
+import java.util.logging.Logger;
+
+import seedu.address.commons.core.LogsCenter;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 
@@ -14,11 +17,13 @@ public class UndoCommand extends Command {
 
     public static final String MESSAGE_SUCCESS = "Command undone";
 
+    private final Logger logger = LogsCenter.getLogger(UndoCommand.class);
 
     @Override
     public CommandResult execute(Model model) throws CommandException {
         requireNonNull(model);
         model.undoCommand();
+        logger.info("AddressBook successfully undone");
         return new CommandResult(MESSAGE_SUCCESS);
     }
 }
diff --git a/src/main/java/seedu/address/storage/UndoRedoStorage.java b/src/main/java/seedu/address/storage/UndoRedoStorage.java
@@ -3,7 +3,10 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Stack;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
+import seedu.address.commons.core.LogsCenter;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.AddressBook;
 
@@ -14,6 +17,8 @@ public class UndoRedoStorage {
     private List<AddressBook> undoList;
     private Stack<AddressBook> redoStack;
 
+    private final Logger logger = LogsCenter.getLogger(UndoRedoStorage.class);
+
     /**
      * Constructs a {@code UndoRedoStorage}.
      */
@@ -22,25 +27,31 @@ public UndoRedoStorage() {
         redoStack = new Stack<>();
     }
 
-
     private void resize() {
         while (undoList.size() > undoRedoLimit) {
+            logger.info("Undo-able list updated");
             undoList.remove(0);
         }
 
         while (redoStack.size() > undoRedoLimit) {
+            logger.info("Redo-able stack updated");
             redoStack.remove(0);
         }
     }
 
+    /**
+     * Resets the stack storing Redo-able AddressBook states.
+     */
     public void resetRedoStack() {
+        logger.info("Redo-able stack reset");
         redoStack = new Stack<>();
     }
 
     /**
      * Adds an address book to a list for storage.
      */
     public void addToUndo(AddressBook addressBook) {
+        logger.info("New entry in Undo-able list");
         undoList.add(addressBook);
         resize();
     }
@@ -50,6 +61,7 @@ public void addToUndo(AddressBook addressBook) {
      */
     public AddressBook undo() throws CommandException {
         if (undoList.isEmpty() || undoList.size() == 1) {
+            logger.log(Level.WARNING, "Current AddressBook is not undo-able");
             throw new CommandException("No previous command to undo");
         }
 
@@ -67,6 +79,7 @@ public AddressBook undo() throws CommandException {
      */
     public AddressBook redo() throws CommandException {
         if (redoStack.isEmpty()) {
+            logger.log(Level.WARNING, "Current AddressBook is not redo-able");
             throw new CommandException("No previous command to redo");
         }