From 3d5a90ebeb73577e50eab544f9c94b1801a17104 Mon Sep 17 00:00:00 2001 From: nixonwidjaja Date: Mon, 23 Oct 2023 00:28:35 +0800 Subject: [PATCH] Fix checkstyle --- .../seedu/address/model/AddressBookList.java | 34 +++++++++++++++++-- .../logic/commands/AddCommandTest.java | 25 ++++++++++++-- .../logic/commands/BirthdayCommandTest.java | 2 +- .../logic/commands/CommandTestUtil.java | 4 +-- .../logic/commands/ViewCommandTest.java | 2 +- 5 files changed, 59 insertions(+), 8 deletions(-) diff --git a/src/main/java/seedu/address/model/AddressBookList.java b/src/main/java/seedu/address/model/AddressBookList.java index 7558c2d5e49..b67a27ffc89 100644 --- a/src/main/java/seedu/address/model/AddressBookList.java +++ b/src/main/java/seedu/address/model/AddressBookList.java @@ -4,6 +4,9 @@ import java.util.ArrayList; +/** + * Represents the history of AddressBook to allow undo and redo. + */ public class AddressBookList extends ArrayList { private static final String REDO_ERROR_MESSAGE = "There is no command to redo! " + "The command to be redone need to previously modified the employee list."; @@ -13,6 +16,9 @@ public class AddressBookList extends ArrayList { private ArrayList pastCommands = new ArrayList(); private int index; + /** + * Initializes the AddressBookList. + */ public AddressBookList() { super(); index = -1; @@ -30,30 +36,54 @@ public boolean add(AddressBook addressBook) { return super.add(addressBook); } + /** + * Returns the AddressBook at given index. + * @return + */ public AddressBook getAddressBook() { return super.get(index); } + /** + * Updates the current AddressBook to the previous version. + * @return AddressBook + */ public AddressBook undo() { checkArgument(index > 0, UNDO_ERROR_MESSAGE); index--; - return super.get(index); + return getAddressBook(); } + /** + * Updates the current AddressBook to the latest undone version. + * @return AddressBook + */ public AddressBook redo() { checkArgument(index < super.size() - 1, REDO_ERROR_MESSAGE); index++; - return super.get(index); + return getAddressBook(); } + /** + * Stores the history of command texts. + * @param commandText + */ public void addCommandText(String commandText) { this.pastCommands.add(commandText); } + /** + * Gets the previous command text. + * @return previous command text + */ public String undoPastCommand() { return this.pastCommands.get(index); } + /** + * Gets the latest undone command text. + * @return latest undone command text + */ public String redoPastCommand() { return this.pastCommands.get(index - 1); } diff --git a/src/test/java/seedu/address/logic/commands/AddCommandTest.java b/src/test/java/seedu/address/logic/commands/AddCommandTest.java index 90e8253f48e..0099545aa90 100644 --- a/src/test/java/seedu/address/logic/commands/AddCommandTest.java +++ b/src/test/java/seedu/address/logic/commands/AddCommandTest.java @@ -37,7 +37,7 @@ public void execute_personAcceptedByModel_addSuccessful() throws Exception { ModelStubAcceptingPersonAdded modelStub = new ModelStubAcceptingPersonAdded(); Person validPerson = new PersonBuilder().build(); - CommandResult commandResult = new AddCommand(validPerson).execute(modelStub); + CommandResult commandResult = new AddCommand(validPerson).execute(modelStub, ""); assertEquals(String.format(AddCommand.MESSAGE_SUCCESS, Messages.format(validPerson)), commandResult.getFeedbackToUser()); @@ -50,7 +50,8 @@ public void execute_duplicatePerson_throwsCommandException() { AddCommand addCommand = new AddCommand(validPerson); ModelStub modelStub = new ModelStubWithPerson(validPerson); - assertThrows(CommandException.class, AddCommand.MESSAGE_DUPLICATE_PERSON, () -> addCommand.execute(modelStub)); + assertThrows(CommandException.class, AddCommand.MESSAGE_DUPLICATE_PERSON, + () -> addCommand.execute(modelStub, "")); } @Test @@ -157,6 +158,21 @@ public ObservableList getFilteredPersonList() { public void updateFilteredPersonList(Predicate predicate) { throw new AssertionError("This method should not be called."); } + + @Override + public String undo() { + throw new AssertionError("This method should not be called."); + } + + @Override + public String redo() { + throw new AssertionError("This method should not be called."); + } + + @Override + public void addCommandText(String commandText) { + throw new AssertionError("This method should not be called."); + } } /** @@ -199,6 +215,11 @@ public void addPerson(Person person) { public ReadOnlyAddressBook getAddressBook() { return new AddressBook(); } + + @Override + public void addCommandText(String commandText) { + return; + } } } diff --git a/src/test/java/seedu/address/logic/commands/BirthdayCommandTest.java b/src/test/java/seedu/address/logic/commands/BirthdayCommandTest.java index e045400309f..9ade9b14044 100644 --- a/src/test/java/seedu/address/logic/commands/BirthdayCommandTest.java +++ b/src/test/java/seedu/address/logic/commands/BirthdayCommandTest.java @@ -43,7 +43,7 @@ public void execute_birthday_success() { @Test public void execute_birthdayNoResults() { - CommandResult result = new BirthdayCommand(FILTER_TEST_PREDICATE_FAILURE).execute(model); + CommandResult result = new BirthdayCommand(FILTER_TEST_PREDICATE_FAILURE).execute(model, ""); assertEquals(result.toString(), new CommandResult(MESSAGE_FAILURE).toString()); } } diff --git a/src/test/java/seedu/address/logic/commands/CommandTestUtil.java b/src/test/java/seedu/address/logic/commands/CommandTestUtil.java index 3621d7734a3..0752fbc9e70 100644 --- a/src/test/java/seedu/address/logic/commands/CommandTestUtil.java +++ b/src/test/java/seedu/address/logic/commands/CommandTestUtil.java @@ -104,7 +104,7 @@ public class CommandTestUtil { public static void assertCommandSuccess(Command command, Model actualModel, CommandResult expectedCommandResult, Model expectedModel) { try { - CommandResult result = command.execute(actualModel); + CommandResult result = command.execute(actualModel, ""); assertEquals(expectedCommandResult, result); assertEquals(expectedModel, actualModel); } catch (CommandException ce) { @@ -134,7 +134,7 @@ public static void assertCommandFailure(Command command, Model actualModel, Stri AddressBook expectedAddressBook = new AddressBook(actualModel.getAddressBook()); List expectedFilteredList = new ArrayList<>(actualModel.getFilteredPersonList()); - assertThrows(CommandException.class, expectedMessage, () -> command.execute(actualModel)); + assertThrows(CommandException.class, expectedMessage, () -> command.execute(actualModel, "")); assertEquals(expectedAddressBook, actualModel.getAddressBook()); assertEquals(expectedFilteredList, actualModel.getFilteredPersonList()); } diff --git a/src/test/java/seedu/address/logic/commands/ViewCommandTest.java b/src/test/java/seedu/address/logic/commands/ViewCommandTest.java index 35e510c0b1a..2a53e551573 100644 --- a/src/test/java/seedu/address/logic/commands/ViewCommandTest.java +++ b/src/test/java/seedu/address/logic/commands/ViewCommandTest.java @@ -105,7 +105,7 @@ public void execute_validMultiplePhone_failure() throws CommandException { + "1. %s's Department is %s.\n\n", firstPersonToView.getName(), firstPersonToView.getDepartment()) + String.format("You are viewing Claim Budget:\n" + "1. %s's Claim Budget is %s.\n\n", secondPersonToView.getName(), secondPersonToView.getClaimBudget()); - assertNotEquals(newViewCommand.execute(model).toString(), wrongReponse); + assertNotEquals(newViewCommand.execute(model, "").toString(), wrongReponse); } @Test