Diff Utils library is an open source library for performing comparison operations between texts: computing diffs, applying patches, generating unified diffs or parsing them, generating diff output for easy future displaying (like side-by-side view) and so on.
The main reason to build this library was the lack of easy-to-use libraries with all the usual stuff you need while working with diff files. Originally it was inspired by JRCS library and its nice design of diff module.
This is originally a fork of java-diff-utils from Google Code Archive.
The GPG signing key in [KEYS] is used for this project's artifacts.
Javadocs of the actual release version: Javadocs java-diff-utils
Look here to find more helpful information and examples.
These two outputs are generated using java-diff-utils. The source code can also be found on the Examples page:
Producing a one liner including all difference information.
// Create a configured DiffRowGenerator DiffRowGenerator generator = DiffRowGenerator.create() .showInlineDiffs(true) .mergeOriginalRevised(true) .inlineDiffByWord(true) .oldTag(f -> "~") // Introduce markdown style for strikethrough .newTag(f -> "**") // Introduce markdown style for bold .build(); // Compute the differences for two test texts List<DiffRow> rows = generator.generateDiffRows( Arrays.asList("This is a test sentence."), Arrays.asList("This is a test for diffutils.")); System.out.println(rows.get(0).getOldLine());
This is a test sentencefor diffutils.
Producing a side-by-side view of computed differences.
DiffRowGenerator generator = DiffRowGenerator.create() .showInlineDiffs(true) .inlineDiffByWord(true) .oldTag(f -> "~") .newTag(f -> "**") .build(); List<DiffRow> rows = generator.generateDiffRows( Arrays.asList("This is a test sentence.", "This is the second line.", "And here is the finish."), Arrays.asList("This is a test for diffutils.", "This is the second line.")); System.out.println("|original|new|"); System.out.println("|--------|---|"); for (DiffRow row : rows) { System.out.println("|" + row.getOldLine() + "|" + row.getNewLine() + "|"); }
| original | new |
|---|---|
| This is a test |
This is a test for diffutils. |
| This is the second line. | This is the second line. |
- Computing the difference between two texts.
- Capable of handling more than plain ASCII. Arrays or lists of any type that implement
hashCode()andequals()correctly can be subject to differencing using this library - Patch and unpatch the text with the given patch
- Parsing the unified diff format
- Producing human-readable differences
- Inline difference construction
- Algorithms:
- Myers standard algorithm
- Myers with linear space improvement
- HistogramDiff using the JGit library
- Myers diff
- HistogramDiff
But it can easily be replaced by any other which is better for handling your texts. I have a plan to add the implementation of some in the future.
Recently a checkstyle process was integrated into the build process. java-diff-utils follows the Sun Java format convention. There are no tabs allowed. Use spaces.
public static <T> Patch<T> diff(List<T> original, List<T> revised, BiPredicate<T, T> equalizer) throws DiffException { if (equalizer != null) { return DiffUtils.diff(original, revised, new MyersDiff<>(equalizer)); } return DiffUtils.diff(original, revised, new MyersDiff<>()); }
This is a valid piece of source code:
- blocks without braces are not allowed
- after control statements (if, while, for) a whitespace is expected
- the opening brace should be in the same line as the control statement
Just add the code below to your Maven dependencies:
<dependency> <groupId>io.github.java-diff-utils</groupId> <artifactId>java-diff-utils</artifactId> <version>4.15</version> </dependency>
or using Gradle:
// https://mvnrepository.com/artifact/io.github.java-diff-utils/java-diff-utils implementation "io.github.java-diff-utils:java-diff-utils:4.12"