Skip to content

Commit

Permalink
Storage documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
louietyj committed Nov 7, 2016
1 parent 415b966 commit 8f43cff
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,8 @@ A Model represents a single database record that is part of the persistent state

**API** : [`Storage.java`](../src/main/java/seedu/todo/storage/Storage.java)

The `Storage` module should be considered to be a black box which provides read/write functionality and a few bonus features to the TodoListDB. This can be compared to a MySQL database implementation - no one needs to know how this is implemented, and in actual fact our implementation does little more than wrap around a serializer / deserializer in order to provide undo/redo functionality.

The `Storage` component,
* holds the logic for saving and loading the TodoListDB from disk
* maintains the required information to undo/redo the state of the TodoListDB in steps. One step represents the changes made in a single atomic transaction
Expand Down

0 comments on commit 8f43cff

Please sign in to comment.