org.test4j.tools.commons
类 TextDiffMatchPatch

java.lang.Object
  org.test4j.tools.commons.TextDiffMatchPatch

public class TextDiffMatchPatch
extends Object

Class containing the diff, match and patch methods. Also contains the behaviour settings.

嵌套类摘要

static class	TextDiffMatchPatch.Diff Class representing one diff operation.
protected static class	TextDiffMatchPatch.LinesToCharsResult Internal class for returning results from diff_linesToChars().
static class	TextDiffMatchPatch.Operation The data structure representing a diff is a Linked list of Diff objects: {Diff(Operation.DELETE, "Hello"), Diff(Operation.INSERT, "Goodbye"), Diff(Operation.EQUAL, " world.")} which means: delete "Hello", add "Goodbye" and keep " world."
static class	TextDiffMatchPatch.Patch Class representing one patch operation.

字段摘要

short	Diff_EditCost Cost of an empty edit operation in terms of edit characters.
float	Diff_Timeout Number of seconds to map a diff before giving up (0 for infinity).
int	Match_Distance How far to search for a match (0 = exact location, 1000+ = broad match).
float	Match_Threshold At what point is no match declared (0.0 = perfection, 1.0 = very loose).
float	Patch_DeleteThreshold When deleting a large block of text (over ~64 characters), how close does the contents have to match the expected contents. (0.0 = perfection, 1.0 = very loose).
short	Patch_Margin Chunk size for context length.

构造方法摘要

TextDiffMatchPatch()

方法摘要

protected LinkedList<TextDiffMatchPatch.Diff>	diff_bisect(String text1, String text2, long deadline) Find the 'middle snake' of a diff, split the problem in two and return the recursively constructed diff.
protected void	diff_charsToLines(LinkedList<TextDiffMatchPatch.Diff> diffs, List<String> lineArray) Rehydrate the text in a diff from a string of line hashes to real lines of text.
void	diff_cleanupEfficiency(LinkedList<TextDiffMatchPatch.Diff> diffs) Reduce the number of edits by eliminating operationally trivial equalities.
void	diff_cleanupMerge(LinkedList<TextDiffMatchPatch.Diff> diffs) Reorder and merge like edit sections.
void	diff_cleanupSemantic(LinkedList<TextDiffMatchPatch.Diff> diffs) Reduce the number of edits by eliminating semantically trivial equalities.
void	diff_cleanupSemanticLossless(LinkedList<TextDiffMatchPatch.Diff> diffs) Look for single edits surrounded on both sides by equalities which can be shifted sideways to align the edit to a word boundary. e.g: The cat came. -> The cat came.
protected int	diff_commonOverlap(String text1, String text2) Determine if the suffix of one string is the prefix of another.
int	diff_commonPrefix(String text1, String text2) Determine the common prefix of two strings
int	diff_commonSuffix(String text1, String text2) Determine the common suffix of two strings
LinkedList<TextDiffMatchPatch.Diff>	diff_fromDelta(String text1, String delta) Given the original text1, and an encoded string which describes the operations required to transform text1 into text2, compute the full diff.
protected String[]	diff_halfMatch(String text1, String text2) Do the two texts share a substring which is at least half the length of the longer text?
int	diff_levenshtein(LinkedList<TextDiffMatchPatch.Diff> diffs) Compute the Levenshtein distance; the number of inserted, deleted or substituted characters.
protected TextDiffMatchPatch.LinesToCharsResult	diff_linesToChars(String text1, String text2) Split two texts into a list of strings.
LinkedList<TextDiffMatchPatch.Diff>	diff_main(String text1, String text2) Find the differences between two texts.
LinkedList<TextDiffMatchPatch.Diff>	diff_main(String text1, String text2, boolean checklines) Find the differences between two texts.
String	diff_prettyHtml(LinkedList<TextDiffMatchPatch.Diff> diffs) Convert a Diff list into a pretty HTML report.
String	diff_text1(LinkedList<TextDiffMatchPatch.Diff> diffs) Compute and return the source text (all equalities and deletions).
String	diff_text2(LinkedList<TextDiffMatchPatch.Diff> diffs) Compute and return the destination text (all equalities and insertions).
String	diff_toDelta(LinkedList<TextDiffMatchPatch.Diff> diffs) Crush the diff into an encoded string which describes the operations required to transform text1 into text2.
int	diff_xIndex(LinkedList<TextDiffMatchPatch.Diff> diffs, int loc) loc is a location in text1, compute and return the equivalent location in text2. e.g.
protected Map<Character,Integer>	match_alphabet(String pattern) Initialise the alphabet for the Bitap algorithm.
protected int	match_bitap(String text, String pattern, int loc) Locate the best instance of 'pattern' in 'text' near 'loc' using the Bitap algorithm.
int	match_main(String text, String pattern, int loc) Locate the best instance of 'pattern' in 'text' near 'loc'.
protected void	patch_addContext(TextDiffMatchPatch.Patch patch, String text) Increase the context until it is unique, but don't let the pattern expand beyond Match_MaxBits.
String	patch_addPadding(LinkedList<TextDiffMatchPatch.Patch> patches) Add some padding on text start and end so that edges can match something.
Object[]	patch_apply(LinkedList<TextDiffMatchPatch.Patch> patches, String text) Merge a set of patches onto the text.
LinkedList<TextDiffMatchPatch.Patch>	patch_deepCopy(LinkedList<TextDiffMatchPatch.Patch> patches) Given an array of patches, return another array that is identical.
List<TextDiffMatchPatch.Patch>	patch_fromText(String textline) Parse a textual representation of patches and return a List of Patch objects.
LinkedList<TextDiffMatchPatch.Patch>	patch_make(LinkedList<TextDiffMatchPatch.Diff> diffs) Compute a list of patches to turn text1 into text2. text1 will be derived from the provided diffs.
LinkedList<TextDiffMatchPatch.Patch>	patch_make(String text1, LinkedList<TextDiffMatchPatch.Diff> diffs) Compute a list of patches to turn text1 into text2. text2 is not provided, diffs are the delta between text1 and text2.
LinkedList<TextDiffMatchPatch.Patch>	patch_make(String text1, String text2) Compute a list of patches to turn text1 into text2.
LinkedList<TextDiffMatchPatch.Patch>	patch_make(String text1, String text2, LinkedList<TextDiffMatchPatch.Diff> diffs) 已过时。 Prefer patch_make(String text1, LinkedList diffs).
void	patch_splitMax(LinkedList<TextDiffMatchPatch.Patch> patches) Look through the patches and break up any which are longer than the maximum limit of the match algorithm.
String	patch_toText(List<TextDiffMatchPatch.Patch> patches) Take a list of patches and return a textual representation.

从类 java.lang.Object 继承的方法

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

字段详细信息

Diff_Timeout

public float Diff_Timeout

Number of seconds to map a diff before giving up (0 for infinity).

Diff_EditCost

public short Diff_EditCost

Cost of an empty edit operation in terms of edit characters.

Match_Threshold

public float Match_Threshold

At what point is no match declared (0.0 = perfection, 1.0 = very loose).

Match_Distance

public int Match_Distance

How far to search for a match (0 = exact location, 1000+ = broad match). A match this many characters away from the expected location will add 1.0 to the score (0.0 is a perfect match).

Patch_DeleteThreshold

public float Patch_DeleteThreshold

When deleting a large block of text (over ~64 characters), how close does the contents have to match the expected contents. (0.0 = perfection, 1.0 = very loose). Note that Match_Threshold controls how closely the end points of a delete need to match.

Patch_Margin

public short Patch_Margin

Chunk size for context length.

构造方法详细信息

TextDiffMatchPatch

public TextDiffMatchPatch()

方法详细信息

diff_main

public LinkedList<TextDiffMatchPatch.Diff> diff_main(String text1,
                                                     String text2)

Find the differences between two texts. Run a faster, slightly less optimal diff. This method allows the 'checklines' of diff_main() to be optional. Most of the time checklines is wanted, so default to true.

参数：

text1 - Old string to be diffed.

text2 - New string to be diffed.

返回：

Linked List of Diff objects.

diff_main

public LinkedList<TextDiffMatchPatch.Diff> diff_main(String text1,
                                                     String text2,
                                                     boolean checklines)

Find the differences between two texts.

参数：

text1 - Old string to be diffed.

text2 - New string to be diffed.

checklines - Speedup flag. If false, then don't run a line-level diff first to identify the changed areas. If true, then run a faster slightly less optimal diff.

返回：

Linked List of Diff objects.

diff_bisect

protected LinkedList<TextDiffMatchPatch.Diff> diff_bisect(String text1,
                                                          String text2,
                                                          long deadline)

Find the 'middle snake' of a diff, split the problem in two and return the recursively constructed diff. See Myers 1986 paper: An O(ND) Difference Algorithm and Its Variations.

参数：

text1 - Old string to be diffed.

text2 - New string to be diffed.

deadline - Time at which to bail if not yet complete.

返回：

LinkedList of Diff objects.

diff_linesToChars

protected TextDiffMatchPatch.LinesToCharsResult diff_linesToChars(String text1,
                                                                  String text2)

Split two texts into a list of strings. Reduce the texts to a string of hashes where each Unicode character represents one line.

参数：

text1 - First string.

text2 - Second string.

返回：

An object containing the encoded text1, the encoded text2 and the List of unique strings. The zeroth element of the List of unique strings is intentionally blank.

diff_charsToLines

protected void diff_charsToLines(LinkedList<TextDiffMatchPatch.Diff> diffs,
                                 List<String> lineArray)

Rehydrate the text in a diff from a string of line hashes to real lines of text.

参数：

diffs - LinkedList of Diff objects.

lineArray - List of unique strings.

diff_commonPrefix

public int diff_commonPrefix(String text1,
                             String text2)

Determine the common prefix of two strings

参数：

text1 - First string.

text2 - Second string.

返回：

The number of characters common to the start of each string.

diff_commonSuffix

public int diff_commonSuffix(String text1,
                             String text2)

Determine the common suffix of two strings

参数：

text1 - First string.

text2 - Second string.

返回：

The number of characters common to the end of each string.

diff_commonOverlap

protected int diff_commonOverlap(String text1,
                                 String text2)

Determine if the suffix of one string is the prefix of another.

参数：

text1 - First string.

text2 - Second string.

返回：

The number of characters common to the end of the first string and the start of the second string.

diff_halfMatch

protected String[] diff_halfMatch(String text1,
                                  String text2)

Do the two texts share a substring which is at least half the length of the longer text? This speedup can produce non-minimal diffs.

参数：

text1 - First string.

text2 - Second string.

返回：

Five element String array, containing the prefix of text1, the suffix of text1, the prefix of text2, the suffix of text2 and the common middle. Or null if there was no match.

diff_cleanupSemantic

public void diff_cleanupSemantic(LinkedList<TextDiffMatchPatch.Diff> diffs)

Reduce the number of edits by eliminating semantically trivial equalities.

参数：

diffs - LinkedList of Diff objects.

diff_cleanupSemanticLossless

public void diff_cleanupSemanticLossless(LinkedList<TextDiffMatchPatch.Diff> diffs)

Look for single edits surrounded on both sides by equalities which can be shifted sideways to align the edit to a word boundary. e.g: The cat came. -> The cat came.

参数：

diffs - LinkedList of Diff objects.

diff_cleanupEfficiency

public void diff_cleanupEfficiency(LinkedList<TextDiffMatchPatch.Diff> diffs)

Reduce the number of edits by eliminating operationally trivial equalities.

参数：

diffs - LinkedList of Diff objects.

diff_cleanupMerge

public void diff_cleanupMerge(LinkedList<TextDiffMatchPatch.Diff> diffs)

Reorder and merge like edit sections. Merge equalities. Any edit section can move as long as it doesn't cross an equality.

参数：

diffs - LinkedList of Diff objects.

diff_xIndex

public int diff_xIndex(LinkedList<TextDiffMatchPatch.Diff> diffs,
                       int loc)

loc is a location in text1, compute and return the equivalent location in text2. e.g. "The cat" vs "The big cat", 1->1, 5->8

参数：

diffs - LinkedList of Diff objects.

loc - Location within text1.

返回：

Location within text2.

diff_prettyHtml

public String diff_prettyHtml(LinkedList<TextDiffMatchPatch.Diff> diffs)

Convert a Diff list into a pretty HTML report.

参数：

diffs - LinkedList of Diff objects.

返回：

HTML representation.

diff_text1

public String diff_text1(LinkedList<TextDiffMatchPatch.Diff> diffs)

Compute and return the source text (all equalities and deletions).

参数：

diffs - LinkedList of Diff objects.

返回：

Source text.

diff_text2

public String diff_text2(LinkedList<TextDiffMatchPatch.Diff> diffs)

Compute and return the destination text (all equalities and insertions).

参数：

diffs - LinkedList of Diff objects.

返回：

Destination text.

diff_levenshtein

public int diff_levenshtein(LinkedList<TextDiffMatchPatch.Diff> diffs)

Compute the Levenshtein distance; the number of inserted, deleted or substituted characters.

参数：

diffs - LinkedList of Diff objects.

返回：

Number of changes.

diff_toDelta

public String diff_toDelta(LinkedList<TextDiffMatchPatch.Diff> diffs)

Crush the diff into an encoded string which describes the operations required to transform text1 into text2. E.g. =3\t-2\t+ing -> Keep 3 chars, delete 2 chars, insert 'ing'. Operations are tab-separated. Inserted text is escaped using %xx notation.

参数：

diffs - Array of diff tuples.

返回：

Delta text.

diff_fromDelta

public LinkedList<TextDiffMatchPatch.Diff> diff_fromDelta(String text1,
                                                          String delta)
                                                   throws IllegalArgumentException

Given the original text1, and an encoded string which describes the operations required to transform text1 into text2, compute the full diff.

参数：

text1 - Source string for the diff.

delta - Delta text.

返回：

Array of diff tuples or null if invalid.

抛出：

IllegalArgumentException - If invalid input.

match_main

public int match_main(String text,
                      String pattern,
                      int loc)

Locate the best instance of 'pattern' in 'text' near 'loc'. Returns -1 if no match found.

参数：

text - The text to search.

pattern - The pattern to search for.

loc - The location to search around.

返回：

Best match index or -1.

match_bitap

protected int match_bitap(String text,
                          String pattern,
                          int loc)

Locate the best instance of 'pattern' in 'text' near 'loc' using the Bitap algorithm. Returns -1 if no match found.

参数：

text - The text to search.

pattern - The pattern to search for.

loc - The location to search around.

返回：

Best match index or -1.

match_alphabet

protected Map<Character,Integer> match_alphabet(String pattern)

Initialise the alphabet for the Bitap algorithm.

参数：

pattern - The text to encode.

返回：

Hash of character locations.

patch_addContext

protected void patch_addContext(TextDiffMatchPatch.Patch patch,
                                String text)

Increase the context until it is unique, but don't let the pattern expand beyond Match_MaxBits.

参数：

patch - The patch to grow.

text - Source text.

patch_make

public LinkedList<TextDiffMatchPatch.Patch> patch_make(String text1,
                                                       String text2)

Compute a list of patches to turn text1 into text2. A set of diffs will be computed.

参数：

text1 - Old text.

text2 - New text.

返回：

LinkedList of Patch objects.

patch_make

public LinkedList<TextDiffMatchPatch.Patch> patch_make(LinkedList<TextDiffMatchPatch.Diff> diffs)

Compute a list of patches to turn text1 into text2. text1 will be derived from the provided diffs.

参数：

diffs - Array of diff tuples for text1 to text2.

返回：

LinkedList of Patch objects.

patch_make

public LinkedList<TextDiffMatchPatch.Patch> patch_make(String text1,
                                                       String text2,
                                                       LinkedList<TextDiffMatchPatch.Diff> diffs)

已过时。 Prefer patch_make(String text1, LinkedList diffs).

Compute a list of patches to turn text1 into text2. text2 is ignored, diffs are the delta between text1 and text2.

参数：

text1 - Old text

text2 - Ignored.

diffs - Array of diff tuples for text1 to text2.

返回：

LinkedList of Patch objects.

patch_make

public LinkedList<TextDiffMatchPatch.Patch> patch_make(String text1,
                                                       LinkedList<TextDiffMatchPatch.Diff> diffs)

Compute a list of patches to turn text1 into text2. text2 is not provided, diffs are the delta between text1 and text2.

参数：

text1 - Old text.

diffs - Array of diff tuples for text1 to text2.

返回：

LinkedList of Patch objects.

patch_deepCopy

public LinkedList<TextDiffMatchPatch.Patch> patch_deepCopy(LinkedList<TextDiffMatchPatch.Patch> patches)

Given an array of patches, return another array that is identical.

参数：

patches - Array of patch objects.

返回：

Array of patch objects.

patch_apply

public Object[] patch_apply(LinkedList<TextDiffMatchPatch.Patch> patches,
                            String text)

Merge a set of patches onto the text. Return a patched text, as well as an array of true/false values indicating which patches were applied.

参数：

patches - Array of patch objects

text - Old text.

返回：

Two element Object array, containing the new text and an array of boolean values.

patch_addPadding

public String patch_addPadding(LinkedList<TextDiffMatchPatch.Patch> patches)

Add some padding on text start and end so that edges can match something. Intended to be called only from within patch_apply.

参数：

patches - Array of patch objects.

返回：

The padding string added to each side.

patch_splitMax

public void patch_splitMax(LinkedList<TextDiffMatchPatch.Patch> patches)

Look through the patches and break up any which are longer than the maximum limit of the match algorithm. Intended to be called only from within patch_apply.

参数：

patches - LinkedList of Patch objects.

patch_toText

public String patch_toText(List<TextDiffMatchPatch.Patch> patches)

Take a list of patches and return a textual representation.

参数：

patches - List of Patch objects.

返回：

Text representation of patches.

patch_fromText

public List<TextDiffMatchPatch.Patch> patch_fromText(String textline)
                                              throws IllegalArgumentException

Parse a textual representation of patches and return a List of Patch objects.

参数：

textline - Text representation of patches.

返回：

List of Patch objects.

抛出：

IllegalArgumentException - If invalid input.