Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[T6A3][F10-C4]Li Xiaowei #849

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 9 additions & 16 deletions src/seedu/addressbook/logic/Logic.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import seedu.addressbook.data.person.ReadOnlyPerson;
import seedu.addressbook.parser.Parser;
import seedu.addressbook.storage.StorageFile;
import seedu.addressbook.storage.StorageStub;

import java.util.Collections;
import java.util.List;
Expand All @@ -16,10 +17,8 @@
*/
public class Logic {


private StorageFile storage;
private AddressBook addressBook;

public StorageStub storage;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Hmm... if you look at the expected UML diagram, Logic should point to Storage, so it should be public Storage storage. :)

/** The list of person shown to the user most recently. */
private List<? extends ReadOnlyPerson> lastShownList = Collections.emptyList();

Expand All @@ -28,30 +27,24 @@ public Logic() throws Exception{
setAddressBook(storage.load());
}

Logic(StorageFile storageFile, AddressBook addressBook){
Logic(StorageStub storageFile, AddressBook addressBook)throws Exception{
setStorage(storageFile);
setAddressBook(addressBook);
}

void setStorage(StorageFile storage){
void setStorage(StorageStub storage){
this.storage = storage;
}

void setAddressBook(AddressBook addressBook){
this.addressBook = addressBook;
}

/**
* Creates the StorageFile object based on the user specified path (if any) or the default storage path.
* @throws StorageFile.InvalidStorageFilePathException if the target file path is incorrect.
*/
private StorageFile initializeStorage() throws StorageFile.InvalidStorageFilePathException {
return new StorageFile();
}

public String getStorageFilePath() {
return storage.getPath();
}

private StorageStub initializeStorage() throws StorageFile.InvalidStorageFilePathException{
return new StorageStub("addressbook.txt");
}


/**
* Unmodifiable view of the current last shown list.
Expand Down
45 changes: 45 additions & 0 deletions src/seedu/addressbook/storage/Storage.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
package seedu.addressbook.storage;

import java.nio.file.Path;
import java.nio.file.Paths;

import seedu.addressbook.data.AddressBook;
import seedu.addressbook.data.exception.IllegalValueException;
import seedu.addressbook.storage.Storage.InvalidStorageFilePathException;
import seedu.addressbook.storage.Storage.StorageOperationException;

public abstract class Storage {
/** Default file path used if the user doesn't provide the file name. */
public static final String DEFAULT_STORAGE_FILEPATH = "addressbook.txt";

public Path path;

/**
* Signals that the given file path does not fulfill the storage filepath constraints.
*/
public static class InvalidStorageFilePathException extends IllegalValueException {
public InvalidStorageFilePathException(String message) {
super(message);
}
}

/**
* Signals that some error has occured while trying to convert and read/write data between the application
* and the storage file.
*/
public static class StorageOperationException extends Exception {
public StorageOperationException(String message) {
super(message);
}
}
/**
* @throws InvalidStorageFilePathException if the default path is invalid
*/
public Storage() throws InvalidStorageFilePathException {
path=Paths.get(DEFAULT_STORAGE_FILEPATH);
}
public abstract String getPath() ;
public abstract AddressBook load() throws StorageOperationException;
public void save(AddressBook addressBook) throws StorageOperationException {}

}
45 changes: 11 additions & 34 deletions src/seedu/addressbook/storage/StorageFile.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,45 +15,17 @@
/**
* Represents the file used to store address book data.
*/
public class StorageFile {

/** Default file path used if the user doesn't provide the file name. */
public static final String DEFAULT_STORAGE_FILEPATH = "addressbook.txt";
public class StorageFile extends Storage {


/* Note: Note the use of nested classes below.
* More info https://docs.oracle.com/javase/tutorial/java/javaOO/nested.html
*/

/**
* Signals that the given file path does not fulfill the storage filepath constraints.
*/
public static class InvalidStorageFilePathException extends IllegalValueException {
public InvalidStorageFilePathException(String message) {
super(message);
}
}

/**
* Signals that some error has occured while trying to convert and read/write data between the application
* and the storage file.
*/
public static class StorageOperationException extends Exception {
public StorageOperationException(String message) {
super(message);
}
}

private final JAXBContext jaxbContext;

public final Path path;

/**
* @throws InvalidStorageFilePathException if the default path is invalid
*/
public StorageFile() throws InvalidStorageFilePathException {
this(DEFAULT_STORAGE_FILEPATH);
}


/**
* @throws InvalidStorageFilePathException if the given file path is invalid
*/
Expand Down Expand Up @@ -141,8 +113,13 @@ public AddressBook load() throws StorageOperationException {
}
}

public String getPath() {
return path.toString();
}
@Override
public String getPath() {
// TODO Auto-generated method stub
return path.toString();
}




}
75 changes: 75 additions & 0 deletions src/seedu/addressbook/storage/StorageStub.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
package seedu.addressbook.storage;

import seedu.addressbook.data.AddressBook;
import seedu.addressbook.storage.jaxb.AdaptedAddressBook;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import java.nio.file.Path;
import java.nio.file.Paths;

/**
* Represents the file used to store address book data.
*/
public class StorageStub extends Storage {


/* Note: Note the use of nested classes below.
* More info https://docs.oracle.com/javase/tutorial/java/javaOO/nested.html
*/


/**
* @throws InvalidStorageFilePathException if the given file path is invalid
*/
public StorageStub(String filePath) throws InvalidStorageFilePathException {
try {
JAXBContext.newInstance(AdaptedAddressBook.class);
} catch (JAXBException jaxbe) {
throw new RuntimeException("jaxb initialisation error");
}

path = Paths.get(filePath);
if (!isValidPath(path)) {
throw new InvalidStorageFilePathException("Storage file should end with '.txt'");
}
}

/**
* Returns true if the given path is acceptable as a storage file.
* The file path is considered acceptable if it ends with '.txt'
*/
private static boolean isValidPath(Path filePath) {
return filePath.toString().endsWith(".txt");
}

/**
* Saves all data to this storage file.
*
* @throws StorageOperationException if there were errors converting and/or storing data to file.
*/
public void save(AddressBook addressBook) throws StorageOperationException {


}

/**
* Loads data from this storage file.
*
* @throws StorageOperationException if there were errors reading and/or converting data from file.
*/
public AddressBook load() throws StorageOperationException {
return new AddressBook();
}

@Override
public String getPath() {
// TODO Auto-generated method stub
return path.toString();
}




}

2 changes: 1 addition & 1 deletion src/seedu/addressbook/ui/Gui.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public Gui(Logic logic, String version) {

public void start(Stage stage, Stoppable mainApp) throws IOException {
mainWindow = createMainWindow(stage, mainApp);
mainWindow.displayWelcomeMessage(version, logic.getStorageFilePath());
mainWindow.displayWelcomeMessage(version, logic.storage.getPath());
}

private MainWindow createMainWindow(Stage stage, Stoppable mainApp) throws IOException{
Expand Down
6 changes: 3 additions & 3 deletions test/java/seedu/addressbook/logic/LogicTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
import seedu.addressbook.data.person.*;
import seedu.addressbook.data.tag.Tag;
import seedu.addressbook.data.tag.UniqueTagList;
import seedu.addressbook.storage.StorageFile;
import seedu.addressbook.storage.StorageStub;

import java.util.*;

Expand All @@ -28,13 +28,13 @@ public class LogicTest {
@Rule
public TemporaryFolder saveFolder = new TemporaryFolder();

private StorageFile saveFile;
private StorageStub saveFile;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job! You can consider using Storage saveFile too, since Storage saveFile = new StorageStub() works too! But you did correctly, no worries! ^^

private AddressBook addressBook;
private Logic logic;

@Before
public void setup() throws Exception {
saveFile = new StorageFile(saveFolder.newFile("testSaveFile.txt").getPath());
saveFile = new StorageStub(saveFolder.newFile("testSaveFile.txt").getPath());
addressBook = new AddressBook();
saveFile.save(addressBook);
logic = new Logic(saveFile, addressBook);
Expand Down