# making/yavi architecture

> Architecture diagram of the GitHub repository making/yavi, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/making/yavi
- Repository: https://github.com/making/yavi

## Overview

##### Main Components

a. Core Validation Engine
- Core validator components (Validator, ValidatorBuilder, ConstraintViolations)

b. Constraint System
- This as a major subsystem connected to the core
- Different types of constraints:
- Primitive type constraints (Integer, String, etc.)
- Collection constraints
- Custom constraints

c. Builder Framework
- As a separate component that interfaces with the core
- ValidatorBuilder and its related components

##### Key Relationships to Highlight

a. Data Flow
- Input flow: Object → Validator → Validation Result
- Constraint application flow: ValidatorBuilder → Validator → Constraints

b. Component Integration
- How the builder pattern connects to the core validator
- How constraints are applied to different types
- Relationship between validators and violation reporting

##### Architectural Patterns to Emphasize

a. Builder Pattern Implementation
- ValidatorBuilder hierarchy
- How it constructs validators

b. Constraint Chain
- How multiple constraints can be chained
- Type-safe nature of constraints

##### Detailed Components

Core Layer:

- Core Validator     |

- Validator           |
- ConstraintViolations|
- ValidatorBuilder    |

Constraint Layer:

- Constraint System    |

- Primitive Constraints |
- Custom Constraints    |
- Collection Constraints|

Builder Layer:

- Builder Framework    |

- ValidatorBuilder     |
- ConstraintBuilder    |
- ArgumentsBuilder     |

##### Implementation Details

- Rectangles for core components
- Rounded rectangles for constraints
- Hexagons for builders

- Relationship types

##### Additional Elements

- Validation flow direction
- Error handling paths
- Thread-safe nature of validators
- How custom constraints can be integrated

- No reflection usage
- No runtime annotations
- Support for any object type
- Thread-safe validation

Remember to maintain a balance between detail and clarity, focusing on the core architectural components while providing enough detail to understand the system's operation.

This design should reflect YAVI's philosophy of being lightweight, type-safe, and flexible while maintaining high performance through its lambda-based approach.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef core fill:#b3d1ff,stroke:#4d88ff
    classDef constraint fill:#b3ffb3,stroke:#4dff4d
    classDef builder fill:#ffd9b3,stroke:#ffb366
    classDef message fill:#ffb3b3,stroke:#ff6666
    classDef factory fill:#d9b3ff,stroke:#b366ff
    classDef meta fill:#ffff99,stroke:#ffff00
    classDef arguments fill:#99ffff,stroke:#00ffff
    classDef functions fill:#ff99ff,stroke:#ff00ff

    %% Core Validation Engine
    subgraph CoreEngine
        Validator["Validator"]:::core
        ConstraintViolations["ConstraintViolations"]:::core
        CoreValidatorBuilder["Core ValidatorBuilder"]:::core
    end

    %% Constraint System
    subgraph ConstraintSystem
        ConstraintBase["Constraint Base"]:::constraint
        CharSequenceConstraint["CharSequence Constraint"]:::constraint
        ArrayConstraints["Array Constraints"]:::constraint
        CustomConstraints["Custom Constraints"]:::constraint
    end

    %% Builder Framework
    subgraph BuilderFramework
        ValidatorBuilder["Validator Builder"]:::builder
        ArgumentsValidatorBuilder["Arguments Validator Builder"]:::builder
        ValueValidatorBuilder["Value Validator Builder"]:::builder
    end

    %% Message Handling
    subgraph MessageSystem
        MessageFormatter["Message Formatter"]:::message
        SimpleMessageFormatter["Simple Message Formatter"]:::message
    end

    %% Factory Components
    subgraph FactorySystem
        ValidatorFactory["Validator Factory"]:::factory
        BiValidatorFactory["Bi Validator Factory"]:::factory
    end

    %% Meta Components
    subgraph MetaSystem
        ConstraintMeta["Constraint Meta"]:::meta
        ConstraintTarget["Constraint Target"]:::meta
    end

    %% Arguments System
    subgraph ArgumentsSystem
        Arguments["Arguments"]:::arguments
        ArgumentsValidators["Arguments Validators"]:::arguments
    end

    %% Core Functions
    subgraph CoreFunctions
        Validation["Validation"]:::functions
        Functions["Functions"]:::functions
    end

    %% Relationships
    Validator --> ConstraintViolations
    CoreValidatorBuilder --> Validator
    ConstraintBase --> Validator
    ValidatorBuilder --> CoreValidatorBuilder
    ArgumentsValidatorBuilder --> ValidatorBuilder
    ValueValidatorBuilder --> ValidatorBuilder
    MessageFormatter --> ConstraintViolations
    SimpleMessageFormatter --> MessageFormatter
    ValidatorFactory --> Validator
    BiValidatorFactory --> ValidatorFactory
    ConstraintMeta --> ConstraintBase
    Arguments --> ArgumentsValidators
    Validation --> Functions

    %% Click Events
    click Validator "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/core/Validator.java"
    click ConstraintViolations "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/core/ConstraintViolations.java"
    click CoreValidatorBuilder "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/core/ValidatorBuilder.java"
    click ConstraintBase "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/constraint/base/ConstraintBase.java"
    click CharSequenceConstraint "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/constraint/charsequence/CharSequenceConstraint.java"
    click ArrayConstraints "https://github.com/making/yavi/tree/develop/src/main/java/am/ik/yavi/constraint/array/"
    click ValidatorBuilder "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/builder/ValidatorBuilder.java"
    click ArgumentsValidatorBuilder "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/builder/ArgumentsValidatorBuilder.java"
    click ValueValidatorBuilder "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/builder/ValueValidatorBuilder.java"
    click MessageFormatter "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/message/MessageFormatter.java"
    click SimpleMessageFormatter "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/message/SimpleMessageFormatter.java"
    click ValidatorFactory "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/factory/ValidatorFactory.java"
    click BiValidatorFactory "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/factory/BiValidatorFactory.java"
    click ConstraintMeta "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/meta/ConstraintMeta.java"
    click ConstraintTarget "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/meta/ConstraintTarget.java"
    click Arguments "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/arguments/Arguments.java"
    click ArgumentsValidators "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/arguments/ArgumentsValidators.java"
    click Validation "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/fn/Validation.java"
    click Functions "https://github.com/making/yavi/blob/develop/src/main/java/am/ik/yavi/fn/Functions.java"
```
