How siom79/japicmp works
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: JApiClass.java Class and member diff · JApiCmpTask.java Ant task · JarArchiveComparator.java Archive comparator · JApiCmpProcessor.java Maven processor
Components 19
Inputs and configuration
- CLI parser
japicmp/src/main/java/japicmp/cli/CliParser.java - Comparison options
japicmp/src/main/java/japicmp/config/Options.java - Archive inputs
japicmp/src/main/java/japicmp/cmp/JApiCmpArchive.java - Comparator options
japicmp/src/main/java/japicmp/cmp/JarArchiveComparatorOptions.java
Comparison analysis
- Archive comparator
japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java - Class and member diff
japicmp/src/main/java/japicmp/model/JApiClass.java - Signature parsing
japicmp/src/main/java/japicmp/util/SignatureParser.java - Compatibility rules
japicmp/src/main/java/japicmp/compat/CompatibilityChanges.java
Reports and verdicts
- Markdown report
japicmp/src/main/java/japicmp/output/markdown/MarkdownOutputGenerator.java - HTML report
japicmp/src/main/java/japicmp/output/html/HtmlOutputGenerator.java - XML report
japicmp/src/main/java/japicmp/output/xml/XmlOutputGenerator.java - Diff output
japicmp/src/main/java/japicmp/output/stdout/StdoutOutputGenerator.java - Version verdict
japicmp/src/main/java/japicmp/output/semver/SemverOut.java
Build integrations
- Maven goal
japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpMojo.java - Maven processor
japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpProcessor.java - Ant task
japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java
Other components
- Engineer
- Maven build
- Ant build
Connections 27
- Engineer → CLI parser: supplies arguments
README.md - CLI parser → Comparison options: parses into
japicmp/src/main/java/japicmp/cli/CliParser.java - Comparison options → Archive inputs: configures inputs
japicmp/src/main/java/japicmp/config/Options.java - Archive comparator → Archive inputs: reads archives
japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java - Comparison options → Comparator options: maps settings
japicmp/src/main/java/japicmp/cmp/JarArchiveComparatorOptions.java - Archive comparator → Comparator options: uses settings
japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java - Archive comparator → Class and member diff: produces class changes
japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java - Class and member diff → Signature parsing: parses signatures
japicmp/src/main/java/japicmp/model/JApiClass.java - Archive comparator → Compatibility rules: evaluates changes
japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java - Engineer → Archive comparator: compares through API
README.md - Class and member diff → Diff output: renders diff
japicmp/src/main/java/japicmp/output/stdout/StdoutOutputGenerator.java - Class and member diff → Markdown report: renders report
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
README.md - Maven goal → Maven processor: delegates analysis
japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpMojo.java - Maven processor → Archive comparator: compares archives
japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpProcessor.java - Maven processor → Markdown report: generates reports
japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpProcessor.java - Maven processor → HTML report: generates reports
japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpProcessor.java - Ant build → Ant task: runs task
README.md - Ant task → Archive comparator: compares archives
japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java - Ant task → Diff output: prints diff
japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java - Ant task → Markdown report: generates report
japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java - Ant task → HTML report: generates report
japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java - Ant task → XML report: generates report
japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java - Ant task → Version verdict: prints verdict
japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java