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.

Sign up for GitHub

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

Update Developer Guide for the Storage component #63

Merged
merged 1 commit into from
Apr 4, 2024
Merged

Update Developer Guide for the Storage component #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,12 +143,15 @@ The `Model` component,

**API** : [`Storage.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/storage/Storage.java)

<puml src="diagrams/StorageClassDiagram.puml" width="550" />
<puml src="diagrams/StorageClassDiagram.puml" width="850" />

The `Storage` component,
* can save both address book data and user preference data in JSON format, and read them back into corresponding objects.
* inherits from both `AddressBookStorage` and `UserPrefStorage`, which means it can be treated as either one (if only the functionality of only one is needed).
* depends on some classes in the `Model` component (because the `Storage` component's job is to save/retrieve objects that belong to the `Model`)
* can save address book data, task list data and user preference data in JSON format, and read
them back into corresponding objects.
* inherits from AddressBookStorage, TaskListStorage and UserPrefStorage, which means it can be
treated as one of the three classes (if only the functionality of only one is needed).
* depends on some classes in the `Model` component (because the `Storage` component's job is to
save/retrieve objects that belong to the `Model`)

### Common classes

Expand Down
18 changes: 18 additions & 0 deletions docs/diagrams/StorageClassDiagram.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ Class JsonAdaptedPerson
Class JsonAdaptedTag
}

package "TaskList Storage" #F4F6F6{
Class "<<interface>>\nTaskListStorage" as TaskListStorage
Class JsonTaskListStorage
Class JsonSerializableTaskList
Class JsonAdaptedTask
}

}

Class HiddenOutside #FFFFFF
Expand All @@ -30,14 +37,25 @@ HiddenOutside ..> Storage
StorageManager .up.|> Storage
StorageManager -up-> "1" UserPrefsStorage
StorageManager -up-> "1" AddressBookStorage
StorageManager -up-> "1" TaskListStorage


Storage -left-|> UserPrefsStorage
Storage -right-|> AddressBookStorage
Storage -down-|> TaskListStorage


JsonUserPrefsStorage .up.|> UserPrefsStorage
JsonAddressBookStorage .up.|> AddressBookStorage
JsonAddressBookStorage ..> JsonSerializableAddressBook
JsonSerializableAddressBook --> "*" JsonAdaptedPerson
JsonAdaptedPerson --> "*" JsonAdaptedTag

JsonTaskListStorage .up.|> TaskListStorage
JsonTaskListStorage ..> JsonSerializableTaskList
JsonSerializableTaskList --> "*" JsonAdaptedTask

Storage .[hidden]down. StorageManager
StorageManager .[hidden]down. UserPrefsStorage

@enduml
Loading