org.jeditor.diff

Class Diff

java.lang.Object

org.jeditor.diff.Diff

public class Diff
extends java.lang.Object

A class to compare vectors of objects. The result of comparison is a list of change objects which form an edit script. The objects compared are traditionally lines of text from two files. Comparison options such as "ignore whitespace" are implemented by modifying the equals and hashcode methods for the objects compared. The basic algorithm is described in: "An O(ND) Difference Algorithm and its Variations", Eugene Myers, Algorithmica Vol. 1 No. 2, 1986, p 251. See https://github.com/aymannadeem/speedyscholar/blob/master/an-ond-difference-algorithm-and-its-variations.md

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Diff.change The result of comparison is an "edit script": a chain of change objects.
class	Diff.file_data Data on one input file being compared.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	heuristic When set to true, the comparison uses a heuristic to speed it up.
boolean	no_discards When set to true, the algorithm returns a guarranteed minimal set of changes.

Constructor Summary

Constructors

Constructor and Description
Diff(java.util.List a, java.util.List b) Prepare to find differences between two lists.
Diff(java.lang.Object[] a, java.lang.Object[] b) Prepare to find differences between two arrays.
Diff(java.lang.String a, java.lang.String b) Prepare to find differences between two arrays.

Method Summary

Modifier and Type	Method and Description
Diff.change	diff_2() Report the differences of two files.
Diff.change	diff_2(boolean reverse) Report the differences of two files.
Diff.file_data[]	getFileData()
static java.util.List<java.lang.String>	getLines(java.io.File file) Return a list of lines from a File.
static java.util.List<java.lang.String>	getLines(java.lang.String s) Return a list of lines from a String.
static java.lang.String[]	singleChars(java.lang.String s) Return an array of Strings of one character only from an input String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

heuristic

public boolean heuristic

When set to true, the comparison uses a heuristic to speed it up. With this heuristic, for files with a constant small density of changes, the algorithm is linear in the file size.

no_discards

public boolean no_discards

When set to true, the algorithm returns a guarranteed minimal set of changes. This makes things slower, sometimes much slower.

Constructor Detail

Diff

public Diff(java.lang.String a,
            java.lang.String b)

Prepare to find differences between two arrays. Each element of the arrays is translated to an "equivalence number" based on the result of equals. The original Object arrays are no longer needed for computing the differences. They will be needed again later to print the results of the comparison as an edit script, if desired.

Parameters:

a - the first String

b - the second String

Diff

public Diff(java.lang.Object[] a,
            java.lang.Object[] b)

Prepare to find differences between two arrays. Each element of the arrays is translated to an "equivalence number" based on the result of equals. The original Object arrays are no longer needed for computing the differences. They will be needed again later to print the results of the comparison as an edit script, if desired.

Parameters:

a - the first object

b - the second object

Diff

public Diff(java.util.List a,
            java.util.List b)

Prepare to find differences between two lists.

Parameters:

a - the first object

b - the second object

Method Detail

singleChars

public static final java.lang.String[] singleChars(java.lang.String s)

Return an array of Strings of one character only from an input String.

Parameters:

s - the input string

Returns:

the array of Strings

getLines

public static java.util.List<java.lang.String> getLines(java.lang.String s)

Return a list of lines from a String.

Parameters:

s - the String

Returns:

the list of lines

getLines

public static java.util.List<java.lang.String> getLines(java.io.File file)

Return a list of lines from a File.

Parameters:

file - the File

Returns:

the list of lines

getFileData

public Diff.file_data[] getFileData()

diff_2

public Diff.change diff_2()

Report the differences of two files.

Returns:

the differences

diff_2

public Diff.change diff_2(boolean reverse)

Report the differences of two files.

Parameters:

reverse - if the difference is performed on reverse

Returns:

the differences