# leonardoz/java-concurrency-patterns architecture

> Architecture diagram of the GitHub repository leonardoz/java-concurrency-patterns, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-10). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/leonardoz/java-concurrency-patterns
- Repository: https://github.com/leonardoz/java-concurrency-patterns

## Overview

##### Main architectural view
- This is a single Maven-based Java project.
- It exposes two logical modules of code under the package root `br.com.leonardoz`:
- **features** (concrete usage examples of Java concurrency APIs)
- **patterns** (higher-level concurrency design patterns)

##### Major components
A. **Developer / Consumer** (External actor)
– Clones or forks the GitHub repository.
– Uses Maven to build, run, or import examples into an IDE.
B. **Source Repository**
– Top-level project containing `pom.xml`, `README.md`, and the `src` tree.
C. **Build System (Maven)**
– Reads `pom.xml`: compiles all Java packages, runs any tests, packages examples into a JAR (if configured).
D. **JDK Concurrency API** (External library)
– The `java.util.concurrent` package and related APIs that every sample depends on.
E. **Example Modules** (Internal code components)
1. **Features Module**
– Subpackages:
- `threads`
- `locks` (intrinsic, reentrant, read-write)
- `synchronizers` (latches, barriers, semaphores)
- `collections` (synchronized, concurrent)
- `executors` (all ExecutorService variants)
- `futures` (FutureTask, CompletableFuture)
- `forkjoin`
- `parallel_stream`
- `java_memory_model`
- `atomics`
2. **Patterns Module**
– Subpackages implementing thread-safe design patterns:
- shared-state protection
- atomic compound actions
- lock splitting
- fixed lock ordering
- thread-local confinement
- immutable objects
- lazy initialization
- safe publishing
- resource pools
- condition queues (wait/notify, await/signal)
- background task executor
- task cancel/convergence
- producer-consumer, divide-and-conquer, non-blocking, etc.

##### Relationships and interactions
- **Developer** → (clone/pull) → **Source Repository**
- **Source Repository** → (invoke) → **Maven Build**
- **Maven Build** → (compile/link) → **Example Modules** + **JDK Concurrency API**
- **Maven Build** → (package) → deliverable JAR or IDE project
- **Developer** → (run/examples) → **Example Modules** → console output

##### Architectural patterns and design principles
- The project is structured by **package grouping**, not by services or layers.
- It follows **modular separation** of “features” vs “patterns.”
- Each subpackage is a **self-contained example**, depending only on the JDK.

## Diagram (Mermaid)

```mermaid
flowchart TB
    Developer["Developer / Consumer"]:::actor
    SourceRepo["Source Repository"]:::infra
    Maven["Maven Build System"]:::infra
    JDK["JDK Concurrency API"]:::infra

    subgraph "Example Modules"
        subgraph "Features Module"
            FeaturesDir["br.com.leonardoz.features"]:::features
            Atomics["UsingAtomics.java"]:::features
            Collections["UsingConcurrentCollections.java"]:::features
            Executors["UsingExecutors.java"]:::features
        end
        subgraph "Patterns Module"
            PatternsDir["br.com.leonardoz.patterns"]:::patterns
            GuardedBy["GuardedBy.java"]:::patterns
            ThreadSafeAnnot["ThreadSafe.java"]:::patterns
            Compound["AtomicCompoundActions.java"]:::patterns
            SharedState["ProtectedSharedState.java"]:::patterns
        end
    end

    Developer -->|"clone"| SourceRepo
    SourceRepo -->|"build"| Maven
    Maven -->|"compile"| FeaturesDir
    Maven -->|"compile"| PatternsDir
    Maven -->|"link to"| JDK
    Developer -->|"run examples"| FeaturesDir
    Developer -->|"run examples"| PatternsDir

    click SourceRepo "https://github.com/leonardoz/java-concurrency-patterns/blob/master/README.md"
    click SourceRepo "https://github.com/leonardoz/java-concurrency-patterns/blob/master/pom.xml"
    click SourceRepo "https://github.com/leonardoz/java-concurrency-patterns/tree/master/src/"
    click Maven "https://github.com/leonardoz/java-concurrency-patterns/blob/master/pom.xml"
    click FeaturesDir "https://github.com/leonardoz/java-concurrency-patterns/tree/master/src/main/java/br/com/leonardoz/features"
    click Atomics "https://github.com/leonardoz/java-concurrency-patterns/blob/master/src/main/java/br/com/leonardoz/features/atomics/UsingAtomics.java"
    click Collections "https://github.com/leonardoz/java-concurrency-patterns/blob/master/src/main/java/br/com/leonardoz/features/collections/UsingConcurrentCollections.java"
    click Executors "https://github.com/leonardoz/java-concurrency-patterns/blob/master/src/main/java/br/com/leonardoz/features/executors/UsingExecutors.java"
    click PatternsDir "https://github.com/leonardoz/java-concurrency-patterns/tree/master/src/main/java/br/com/leonardoz/patterns"
    click GuardedBy "https://github.com/leonardoz/java-concurrency-patterns/blob/master/src/main/java/br/com/leonardoz/patterns/GuardedBy.java"
    click ThreadSafeAnnot "https://github.com/leonardoz/java-concurrency-patterns/blob/master/src/main/java/br/com/leonardoz/patterns/ThreadSafe.java"
    click Compound "https://github.com/leonardoz/java-concurrency-patterns/blob/master/src/main/java/br/com/leonardoz/patterns/thread_safe/compound_actions/AtomicCompoundActions.java"
    click SharedState "https://github.com/leonardoz/java-concurrency-patterns/blob/master/src/main/java/br/com/leonardoz/patterns/thread_safe/shared_state/ProtectedSharedState.java"

    classDef actor fill:#f96,stroke:#333,stroke-width:1px
    classDef infra fill:#ddd,stroke:#333
    classDef features fill:#bbf,stroke:#333
    classDef patterns fill:#bfb,stroke:#333
```
