# zeeelord/phonebook architecture

> Architecture diagram of the GitHub repository zeeelord/phonebook, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/zeeelord/phonebook
- Repository: https://github.com/zeeelord/phonebook

## Overview

This is a small in-memory phone-book application. A user enters commands in a console; `Main` parses them, calls the phone-book model, and prints results or errors. The model stores case-insensitive name keys and `PhoneBookEntry` values, supporting add, show, update, remove, and list. Separate `AddCommand` and `ShowCommand` implementations are present, but the excerpts do not show `Main` dispatching to them. Update, remove, and list are documented and implemented directly in `Main`; no persistent storage is shown.

Main entry points: [`src/bcu/oladayo/phoneBook/model/PhoneBook.java`](https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/model/PhoneBook.java) (Phone book), [`src/bcu/oladayo/phoneBook/main/Main.java`](https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/main/Main.java) (CLI loop and parser), [`src/bcu/oladayo/phoneBook/main/AddCommand.java`](https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/main/AddCommand.java) (Add command), [`src/bcu/oladayo/phoneBook/main/ShowCommand.java`](https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/main/ShowCommand.java) (Show command)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_cli["Console interface"]
  node_main["CLI loop and parser<br/>[Main.java]"]
  node_invalid["Invalid command error"]
end

subgraph group_commands["Command types"]
  node_command["Command interface<br/>[Command.java]"]
  node_add["Add command<br/>[AddCommand.java]"]
  node_show["Show command<br/>[ShowCommand.java]"]
end

subgraph group_model["Phone-book model"]
  node_book["Phone book<br/>[PhoneBook.java]"]
  node_entry["Phone-book entry"]
  node_already["Duplicate-name error"]
  node_missing["Missing-name error"]
end

node_user(("Console user"))

node_user -->|"enters commands"| node_main
node_main -->|"prints results"| node_user
node_main -->|"executes operations"| node_book
node_main -->|"reads entry"| node_entry
node_main -->|"throws on invalid input"| node_invalid
node_add -->|"implements"| node_command
node_show -->|"implements"| node_command
node_add -->|"adds entry"| node_book
node_show -->|"gets entry"| node_book
node_book -->|"stores and updates"| node_entry
node_book -->|"rejects duplicates"| node_already
node_book -->|"rejects absent names"| node_missing

click node_main "https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/main/Main.java"
click node_invalid "https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/main/InvalidCommandException.java"
click node_command "https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/main/Command.java"
click node_add "https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/main/AddCommand.java"
click node_show "https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/main/ShowCommand.java"
click node_book "https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/model/PhoneBook.java"
click node_entry "https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/model/PhoneBookEntry.java"
click node_already "https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/model/AlreadyPresentException.java"
click node_missing "https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/model/NotPresentException.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_main,node_invalid,node_user toneBlue
class node_command,node_add,node_show toneAmber
class node_book,node_entry,node_already,node_missing toneMint
```

## Components

### Console interface

- [CLI loop and parser](https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/main/Main.java): `src/bcu/oladayo/phoneBook/main/Main.java`
- [Invalid command error](https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/main/InvalidCommandException.java): `src/bcu/oladayo/phoneBook/main/InvalidCommandException.java`

### Command types

- [Command interface](https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/main/Command.java): `src/bcu/oladayo/phoneBook/main/Command.java`
- [Add command](https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/main/AddCommand.java): `src/bcu/oladayo/phoneBook/main/AddCommand.java`
- [Show command](https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/main/ShowCommand.java): `src/bcu/oladayo/phoneBook/main/ShowCommand.java`

### Phone-book model

- [Phone book](https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/model/PhoneBook.java): `src/bcu/oladayo/phoneBook/model/PhoneBook.java`
- [Phone-book entry](https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/model/PhoneBookEntry.java): `src/bcu/oladayo/phoneBook/model/PhoneBookEntry.java`
- [Duplicate-name error](https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/model/AlreadyPresentException.java): `src/bcu/oladayo/phoneBook/model/AlreadyPresentException.java`
- [Missing-name error](https://github.com/zeeelord/phonebook/blob/main/src/bcu/oladayo/phoneBook/model/NotPresentException.java): `src/bcu/oladayo/phoneBook/model/NotPresentException.java`

### Other components

- **Console user**

## Connections

- Console user → CLI loop and parser: enters commands (evidence: `src/bcu/oladayo/phoneBook/main/Main.java`)
- CLI loop and parser → Console user: prints results (evidence: `src/bcu/oladayo/phoneBook/main/Main.java`)
- CLI loop and parser → Phone book: executes operations (evidence: `src/bcu/oladayo/phoneBook/main/Main.java`)
- CLI loop and parser → Phone-book entry: reads entry (evidence: `src/bcu/oladayo/phoneBook/main/Main.java`)
- CLI loop and parser → Invalid command error: throws on invalid input (evidence: `src/bcu/oladayo/phoneBook/main/Main.java`)
- Add command → Command interface: implements (evidence: `src/bcu/oladayo/phoneBook/main/AddCommand.java`)
- Show command → Command interface: implements (evidence: `src/bcu/oladayo/phoneBook/main/ShowCommand.java`)
- Add command → Phone book: adds entry (evidence: `src/bcu/oladayo/phoneBook/main/AddCommand.java`)
- Show command → Phone book: gets entry (evidence: `src/bcu/oladayo/phoneBook/main/ShowCommand.java`)
- Phone book → Phone-book entry: stores and updates (evidence: `src/bcu/oladayo/phoneBook/model/PhoneBook.java`)
- Phone book → Duplicate-name error: rejects duplicates (evidence: `src/bcu/oladayo/phoneBook/model/PhoneBook.java`)
- Phone book → Missing-name error: rejects absent names (evidence: `src/bcu/oladayo/phoneBook/model/PhoneBook.java`)
