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

[T6A1][F14-B2] Zhang Ying #509

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

mlemzing
Copy link

@mlemzing mlemzing commented Mar 3, 2017

No description provided.

Copy link

@chanjunweimy chanjunweimy left a comment

Choose a reason for hiding this comment

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

@Zing1996 good job!!

import seedu.addressbook.data.AddressBook;
import seedu.addressbook.storage.StorageFile.StorageOperationException;

public abstract class Storage {

Choose a reason for hiding this comment

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

This class and its methods should have a header comments. If not, developers who needs to inherit from this class will not know how exactly they should override the methods and other developers who write client code for this class will not know how to use it either.


public abstract class Storage {
public abstract AddressBook load() throws StorageOperationException, seedu.addressbook.storage.StorageStub.StorageOperationException;
public abstract String getPath();

Choose a reason for hiding this comment

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

It is better to give the method header comments in the parent class rather than the child class. The child class can inherit the comment from the parent.

* Loads data from this storage file.
* @throws StorageOperationException
*/
public AddressBook load() throws StorageOperationException {

Choose a reason for hiding this comment

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

Stubs don't usually do any work. So preferably, it should be empty.

@@ -28,13 +29,13 @@
@Rule
public TemporaryFolder saveFolder = new TemporaryFolder();

private StorageFile saveFile;
private StorageStub saveFile;
private AddressBook addressBook;
private Logic logic;

Choose a reason for hiding this comment

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

I notice your test case failed and i think that it is because you compare the file content... You shouldn't because stub doesnt save :P

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants