# opendaylight/yangtools architecture

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

- Interactive diagram: https://gitdiagram.com/opendaylight/yangtools
- Repository: https://github.com/opendaylight/yangtools

## Overview

YANG Tools is a Java toolkit for parsing YANG/YIN schemas, representing modeled data, generating Java bindings, and serializing data as XML or JSON. The principal workflow runs from YANG sources through parsing and semantic model inference to generated bindings and normalized data, which codecs translate to and from wire formats. Maven integration and schema repositories are adjacent capabilities. The README documents the broad workflow; the graph uses it as evidence for those relationships and does not infer finer implementation calls from the limited source excerpts.

Main entry points: [`model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/EffectiveModelContext.java`](https://github.com/opendaylight/yangtools/blob/master/model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/EffectiveModelContext.java) (Effective model), [`data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangInstanceIdentifier.java`](https://github.com/opendaylight/yangtools/blob/master/data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangInstanceIdentifier.java) (Normalized data API), [`plugin/yang-maven-plugin/src/main/java/org/opendaylight/yangtools/yang2sources/plugin`](https://github.com/opendaylight/yangtools/tree/master/plugin/yang-maven-plugin/src/main/java/org/opendaylight/yangtools/yang2sources/plugin) (Maven integration), [`binding/binding-codegen/src/main/java/org/opendaylight/yangtools/binding/codegen/BindingJavaFileGenerator.java`](https://github.com/opendaylight/yangtools/blob/master/binding/binding-codegen/src/main/java/org/opendaylight/yangtools/binding/codegen/BindingJavaFileGenerator.java) (Binding generator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_parse["Parsing and schemas"]
  node_yang_sources["YANG sources"]
  node_parser["YANG parser<br/>[YangParser.java]"]
  node_effective_model["Effective model"]
end

subgraph group_bindings["Java bindings"]
  node_binding_codegen["Binding generator"]
  node_java_bindings["Java bindings<br/>[DataObject.java]"]
  node_binding_runtime["Binding runtime"]
end

subgraph group_data["YANG data"]
  node_normalized_api["Normalized data API"]
  node_data_tree["DOM-like data model"]
end

subgraph group_serialization["Serialization"]
  node_codec_api["Binding codec API"]
  node_codec_dynamic["Dynamic binding codec"]
  node_xml_codec["XML codec"]
  node_json_codec["JSON codec"]
end

subgraph group_integration["Build and repositories"]
  node_schema_repo["Schema repository"]
  node_maven_plugin["Maven integration"]
end

node_author(("YANG authors"))
node_third_party_generators["Third-party generators"]
node_xml_json_clients(("XML/JSON consumers"))

node_author -->|"provides"| node_yang_sources
node_yang_sources -->|"parsed by"| node_parser
node_parser -->|"infers schema"| node_effective_model
node_effective_model -->|"drives generation"| node_binding_codegen
node_binding_codegen -->|"generates"| node_java_bindings
node_effective_model -->|"models data"| node_normalized_api
node_effective_model -->|"defines schema for"| node_data_tree
node_java_bindings -.->|"used with"| node_binding_runtime
node_binding_runtime -->|"supplies runtime context"| node_codec_api
node_codec_api -.->|"implemented by"| node_codec_dynamic
node_normalized_api -->|"serialized as XML"| node_xml_codec
node_normalized_api -->|"serialized as JSON"| node_json_codec
node_xml_codec -->|"writes or reads XML"| node_xml_json_clients
node_json_codec -->|"writes or reads JSON"| node_xml_json_clients
node_yang_sources -->|"processed in build"| node_maven_plugin
node_maven_plugin -->|"integrates generators"| node_binding_codegen
node_maven_plugin -->|"supports"| node_third_party_generators
node_yang_sources -.->|"stored or retrieved"| node_schema_repo

click node_parser "https://github.com/opendaylight/yangtools/blob/master/parser/yang-parser-api/src/main/java/org/opendaylight/yangtools/yang/parser/api/YangParser.java"
click node_effective_model "https://github.com/opendaylight/yangtools/blob/master/model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/EffectiveModelContext.java"
click node_schema_repo "https://github.com/opendaylight/yangtools/blob/master/yang/yang-repo-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaRepository.java"
click node_binding_codegen "https://github.com/opendaylight/yangtools/blob/master/binding/binding-codegen/src/main/java/org/opendaylight/yangtools/binding/codegen/BindingJavaFileGenerator.java"
click node_java_bindings "https://github.com/opendaylight/yangtools/blob/master/binding/binding-spec/src/main/java/org/opendaylight/yangtools/binding/DataObject.java"
click node_binding_runtime "https://github.com/opendaylight/yangtools/blob/master/binding/binding-runtime-api/src/main/java/org/opendaylight/yangtools/binding/runtime/api/BindingRuntimeContext.java"
click node_normalized_api "https://github.com/opendaylight/yangtools/blob/master/data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangInstanceIdentifier.java"
click node_data_tree "https://github.com/opendaylight/yangtools/tree/master/data/yang-data-api/src/main/java"
click node_codec_api "https://github.com/opendaylight/yangtools/blob/master/binding/binding-data-codec-api/src/main/java/org/opendaylight/yangtools/binding/data/codec/api/BindingNormalizedNodeSerializer.java"
click node_codec_dynamic "https://github.com/opendaylight/yangtools/tree/master/binding/binding-data-codec-dynamic/src/main/java/org/opendaylight/yangtools/binding/data/codec/dynamic"
click node_xml_codec "https://github.com/opendaylight/yangtools/blob/master/codec/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/XmlParserStream.java"
click node_json_codec "https://github.com/opendaylight/yangtools/blob/master/codec/yang-data-codec-gson/src/main/java/org/opendaylight/yangtools/yang/data/codec/gson/JsonParserStream.java"
click node_maven_plugin "https://github.com/opendaylight/yangtools/tree/master/plugin/yang-maven-plugin/src/main/java/org/opendaylight/yangtools/yang2sources/plugin"

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_yang_sources,node_parser,node_effective_model toneBlue
class node_binding_codegen,node_java_bindings,node_binding_runtime toneAmber
class node_normalized_api,node_data_tree toneMint
class node_codec_api,node_codec_dynamic,node_xml_codec,node_json_codec toneRose
class node_schema_repo,node_maven_plugin,node_author,node_third_party_generators,node_xml_json_clients toneIndigo
```

## Components

### Parsing and schemas

- **YANG sources**
- [YANG parser](https://github.com/opendaylight/yangtools/blob/master/parser/yang-parser-api/src/main/java/org/opendaylight/yangtools/yang/parser/api/YangParser.java): `parser/yang-parser-api/src/main/java/org/opendaylight/yangtools/yang/parser/api/YangParser.java`
- [Effective model](https://github.com/opendaylight/yangtools/blob/master/model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/EffectiveModelContext.java): `model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/EffectiveModelContext.java`

### Java bindings

- [Binding generator](https://github.com/opendaylight/yangtools/blob/master/binding/binding-codegen/src/main/java/org/opendaylight/yangtools/binding/codegen/BindingJavaFileGenerator.java): `binding/binding-codegen/src/main/java/org/opendaylight/yangtools/binding/codegen/BindingJavaFileGenerator.java`
- [Java bindings](https://github.com/opendaylight/yangtools/blob/master/binding/binding-spec/src/main/java/org/opendaylight/yangtools/binding/DataObject.java): `binding/binding-spec/src/main/java/org/opendaylight/yangtools/binding/DataObject.java`
- [Binding runtime](https://github.com/opendaylight/yangtools/blob/master/binding/binding-runtime-api/src/main/java/org/opendaylight/yangtools/binding/runtime/api/BindingRuntimeContext.java): `binding/binding-runtime-api/src/main/java/org/opendaylight/yangtools/binding/runtime/api/BindingRuntimeContext.java`

### YANG data

- [Normalized data API](https://github.com/opendaylight/yangtools/blob/master/data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangInstanceIdentifier.java): `data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangInstanceIdentifier.java`
- [DOM-like data model](https://github.com/opendaylight/yangtools/tree/master/data/yang-data-api/src/main/java): `data/yang-data-api/src/main/java`

### Serialization

- [Binding codec API](https://github.com/opendaylight/yangtools/blob/master/binding/binding-data-codec-api/src/main/java/org/opendaylight/yangtools/binding/data/codec/api/BindingNormalizedNodeSerializer.java): `binding/binding-data-codec-api/src/main/java/org/opendaylight/yangtools/binding/data/codec/api/BindingNormalizedNodeSerializer.java`
- [Dynamic binding codec](https://github.com/opendaylight/yangtools/tree/master/binding/binding-data-codec-dynamic/src/main/java/org/opendaylight/yangtools/binding/data/codec/dynamic): `binding/binding-data-codec-dynamic/src/main/java/org/opendaylight/yangtools/binding/data/codec/dynamic`
- [XML codec](https://github.com/opendaylight/yangtools/blob/master/codec/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/XmlParserStream.java): `codec/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/XmlParserStream.java`
- [JSON codec](https://github.com/opendaylight/yangtools/blob/master/codec/yang-data-codec-gson/src/main/java/org/opendaylight/yangtools/yang/data/codec/gson/JsonParserStream.java): `codec/yang-data-codec-gson/src/main/java/org/opendaylight/yangtools/yang/data/codec/gson/JsonParserStream.java`

### Build and repositories

- [Schema repository](https://github.com/opendaylight/yangtools/blob/master/yang/yang-repo-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaRepository.java): `yang/yang-repo-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaRepository.java`
- [Maven integration](https://github.com/opendaylight/yangtools/tree/master/plugin/yang-maven-plugin/src/main/java/org/opendaylight/yangtools/yang2sources/plugin): `plugin/yang-maven-plugin/src/main/java/org/opendaylight/yangtools/yang2sources/plugin`

### Other components

- **YANG authors**
- **Third-party generators**
- **XML/JSON consumers**

## Connections

- YANG authors → YANG sources: provides (evidence: `README.md`)
- YANG sources → YANG parser: parsed by (evidence: `README.md`)
- YANG parser → Effective model: infers schema (evidence: `README.md`)
- Effective model → Binding generator: drives generation (evidence: `README.md`)
- Binding generator → Java bindings: generates (evidence: `README.md`)
- Effective model → Normalized data API: models data (evidence: `README.md`)
- Effective model → DOM-like data model: defines schema for (evidence: `README.md`)
- Java bindings → Binding runtime: used with
- Binding runtime → Binding codec API: supplies runtime context (evidence: `binding/binding-data-codec-spi/src/main/java/org/opendaylight/yangtools/binding/data/codec/spi/BindingDOMCodecServices.java`)
- Binding codec API → Dynamic binding codec: implemented by
- Normalized data API → XML codec: serialized as XML (evidence: `README.md`)
- Normalized data API → JSON codec: serialized as JSON (evidence: `README.md`)
- XML codec → XML/JSON consumers: writes or reads XML (evidence: `README.md`)
- JSON codec → XML/JSON consumers: writes or reads JSON (evidence: `README.md`)
- YANG sources → Maven integration: processed in build (evidence: `README.md`)
- Maven integration → Binding generator: integrates generators (evidence: `README.md`)
- Maven integration → Third-party generators: supports (evidence: `README.md`)
- YANG sources → Schema repository: stored or retrieved
