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

Add UML for EditCommand #205

Merged
merged 1 commit into from
Apr 12, 2024
Merged
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
2 changes: 2 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,8 @@ The following sequence diagram summarizes what happens when a user executes a ne

![EditSequenceDiagram.png](images/EditSequenceDiagram.png)

The following activity diagram summarizes what happens when a user executes a new command:
![EditCommandActivityDiagram.png](images/EditCommandActivityDiagram.png)

### Showing help for commands

Expand Down
27 changes: 27 additions & 0 deletions docs/diagrams/EditCommandActivityDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
@startuml
skin rose
skinparam ActivityFontSize 15
skinparam ArrowFontSize 12

start
:User executes command;
:AddressBookParser parses the command;
:EditCommandParser parses the command;
if () then ([index is valid])
if () then ([no duplicate prefixes present])
:get value for each prefix that is present;
:store value in EditPersonDescriptor;
:return new EditCommand;
:replace selected contact with edited contact;
:show all contacts;
else ([duplicate prefixes present])
:show error message;
endif
else ([index is not valid])
:show error message;
endif


stop

@enduml
Binary file added docs/images/EditCommandActivityDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading