# siom79/japicmp architecture

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

- Interactive diagram: https://gitdiagram.com/siom79/japicmp
- Repository: https://github.com/siom79/japicmp

## Overview

japicmp compares Java class files in old and new JARs, producing class/member-level changes and compatibility judgments without requiring reflection or every dependency on the classpath. The principal workflow is to supply two archives, configure comparison rules, inspect their differences, and render a report or semantic-versioning verdict. CLI, Maven, and Ant are separate entry points; the Maven integration additionally supports build checks and custom scripts. Evidence is limited to the README and indexed or excerpted files, so unsampled subsystems are represented only where documented.

Main entry points: [`japicmp/src/main/java/japicmp/model/JApiClass.java`](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/model/JApiClass.java) (Class and member diff), [`japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java`](https://github.com/siom79/japicmp/blob/master/japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java) (Ant task), [`japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java`](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java) (Archive comparator), [`japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpProcessor.java`](https://github.com/siom79/japicmp/blob/master/japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpProcessor.java) (Maven processor)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_inputs["Inputs and configuration"]
  node_cli["CLI parser<br/>[CliParser.java]"]
  node_options["Comparison options<br/>[Options.java]"]
  node_archives["Archive inputs"]
  node_compareopts["Comparator options"]
end

subgraph group_analysis["Comparison analysis"]
  node_comparator["Archive comparator"]
  node_classdiff["Class and member diff<br/>[JApiClass.java]"]
  node_signature["Signature parsing"]
  node_compat["Compatibility rules"]
end

subgraph group_reports["Reports and verdicts"]
  node_markdown["Markdown report"]
  node_html["HTML report"]
  node_xml["XML report"]
  node_stdout["Diff output"]
  node_semver["Version verdict<br/>[SemverOut.java]"]
end

subgraph group_integrations["Build integrations"]
  node_maven["Maven goal<br/>[JApiCmpMojo.java]"]
  node_processor["Maven processor"]
  node_ant["Ant task<br/>[JApiCmpTask.java]"]
end

node_user(("Engineer"))
node_mavenuser(("Maven build"))
node_antuser(("Ant build"))

node_user -->|"supplies arguments"| node_cli
node_cli -->|"parses into"| node_options
node_options -.->|"configures inputs"| node_archives
node_comparator -->|"reads archives"| node_archives
node_options -->|"maps settings"| node_compareopts
node_comparator -->|"uses settings"| node_compareopts
node_comparator -->|"produces class changes"| node_classdiff
node_classdiff -->|"parses signatures"| node_signature
node_comparator -->|"evaluates changes"| node_compat
node_user -->|"compares through API"| node_comparator
node_classdiff -.->|"renders diff"| node_stdout
node_classdiff -.->|"renders report"| node_markdown
node_classdiff -.->|"renders report"| node_html
node_classdiff -.->|"renders report"| node_xml
node_classdiff -.->|"derives version level"| node_semver
node_mavenuser -->|"runs goal"| node_maven
node_maven -->|"delegates analysis"| node_processor
node_processor -->|"compares archives"| node_comparator
node_processor -->|"generates reports"| node_markdown
node_processor -->|"generates reports"| node_html
node_antuser -->|"runs task"| node_ant
node_ant -->|"compares archives"| node_comparator
node_ant -->|"prints diff"| node_stdout
node_ant -->|"generates report"| node_markdown
node_ant -->|"generates report"| node_html
node_ant -->|"generates report"| node_xml
node_ant -->|"prints verdict"| node_semver

click node_cli "https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/cli/CliParser.java"
click node_options "https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/config/Options.java"
click node_archives "https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/cmp/JApiCmpArchive.java"
click node_comparator "https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java"
click node_compareopts "https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/cmp/JarArchiveComparatorOptions.java"
click node_classdiff "https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/model/JApiClass.java"
click node_signature "https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/util/SignatureParser.java"
click node_compat "https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/compat/CompatibilityChanges.java"
click node_markdown "https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/output/markdown/MarkdownOutputGenerator.java"
click node_html "https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/output/html/HtmlOutputGenerator.java"
click node_xml "https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/output/xml/XmlOutputGenerator.java"
click node_stdout "https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/output/stdout/StdoutOutputGenerator.java"
click node_semver "https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/output/semver/SemverOut.java"
click node_maven "https://github.com/siom79/japicmp/blob/master/japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpMojo.java"
click node_processor "https://github.com/siom79/japicmp/blob/master/japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpProcessor.java"
click node_ant "https://github.com/siom79/japicmp/blob/master/japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.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_cli,node_options,node_archives,node_compareopts toneBlue
class node_comparator,node_classdiff,node_signature,node_compat toneAmber
class node_markdown,node_html,node_xml,node_stdout,node_semver toneMint
class node_maven,node_processor,node_ant toneRose
class node_user,node_mavenuser,node_antuser toneIndigo
```

## Components

### Inputs and configuration

- [CLI parser](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/cli/CliParser.java): `japicmp/src/main/java/japicmp/cli/CliParser.java`
- [Comparison options](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/config/Options.java): `japicmp/src/main/java/japicmp/config/Options.java`
- [Archive inputs](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/cmp/JApiCmpArchive.java): `japicmp/src/main/java/japicmp/cmp/JApiCmpArchive.java`
- [Comparator options](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/cmp/JarArchiveComparatorOptions.java): `japicmp/src/main/java/japicmp/cmp/JarArchiveComparatorOptions.java`

### Comparison analysis

- [Archive comparator](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java): `japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java`
- [Class and member diff](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/model/JApiClass.java): `japicmp/src/main/java/japicmp/model/JApiClass.java`
- [Signature parsing](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/util/SignatureParser.java): `japicmp/src/main/java/japicmp/util/SignatureParser.java`
- [Compatibility rules](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/compat/CompatibilityChanges.java): `japicmp/src/main/java/japicmp/compat/CompatibilityChanges.java`

### Reports and verdicts

- [Markdown report](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/output/markdown/MarkdownOutputGenerator.java): `japicmp/src/main/java/japicmp/output/markdown/MarkdownOutputGenerator.java`
- [HTML report](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/output/html/HtmlOutputGenerator.java): `japicmp/src/main/java/japicmp/output/html/HtmlOutputGenerator.java`
- [XML report](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/output/xml/XmlOutputGenerator.java): `japicmp/src/main/java/japicmp/output/xml/XmlOutputGenerator.java`
- [Diff output](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/output/stdout/StdoutOutputGenerator.java): `japicmp/src/main/java/japicmp/output/stdout/StdoutOutputGenerator.java`
- [Version verdict](https://github.com/siom79/japicmp/blob/master/japicmp/src/main/java/japicmp/output/semver/SemverOut.java): `japicmp/src/main/java/japicmp/output/semver/SemverOut.java`

### Build integrations

- [Maven goal](https://github.com/siom79/japicmp/blob/master/japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpMojo.java): `japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpMojo.java`
- [Maven processor](https://github.com/siom79/japicmp/blob/master/japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpProcessor.java): `japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpProcessor.java`
- [Ant task](https://github.com/siom79/japicmp/blob/master/japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java): `japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java`

### Other components

- **Engineer**
- **Maven build**
- **Ant build**

## Connections

- Engineer → CLI parser: supplies arguments (evidence: `README.md`)
- CLI parser → Comparison options: parses into (evidence: `japicmp/src/main/java/japicmp/cli/CliParser.java`)
- Comparison options → Archive inputs: configures inputs (evidence: `japicmp/src/main/java/japicmp/config/Options.java`)
- Archive comparator → Archive inputs: reads archives (evidence: `japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java`)
- Comparison options → Comparator options: maps settings (evidence: `japicmp/src/main/java/japicmp/cmp/JarArchiveComparatorOptions.java`)
- Archive comparator → Comparator options: uses settings (evidence: `japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java`)
- Archive comparator → Class and member diff: produces class changes (evidence: `japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java`)
- Class and member diff → Signature parsing: parses signatures (evidence: `japicmp/src/main/java/japicmp/model/JApiClass.java`)
- Archive comparator → Compatibility rules: evaluates changes (evidence: `japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java`)
- Engineer → Archive comparator: compares through API (evidence: `README.md`)
- Class and member diff → Diff output: renders diff (evidence: `japicmp/src/main/java/japicmp/output/stdout/StdoutOutputGenerator.java`)
- Class and member diff → Markdown report: renders report (evidence: `japicmp/src/main/java/japicmp/output/markdown/MarkdownOutputGenerator.java`)
- Class and member diff → HTML report: renders report
- Class and member diff → XML report: renders report
- Class and member diff → Version verdict: derives version level
- Maven build → Maven goal: runs goal (evidence: `README.md`)
- Maven goal → Maven processor: delegates analysis (evidence: `japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpMojo.java`)
- Maven processor → Archive comparator: compares archives (evidence: `japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpProcessor.java`)
- Maven processor → Markdown report: generates reports (evidence: `japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpProcessor.java`)
- Maven processor → HTML report: generates reports (evidence: `japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpProcessor.java`)
- Ant build → Ant task: runs task (evidence: `README.md`)
- Ant task → Archive comparator: compares archives (evidence: `japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java`)
- Ant task → Diff output: prints diff (evidence: `japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java`)
- Ant task → Markdown report: generates report (evidence: `japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java`)
- Ant task → HTML report: generates report (evidence: `japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java`)
- Ant task → XML report: generates report (evidence: `japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java`)
- Ant task → Version verdict: prints verdict (evidence: `japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java`)
