DiffMatchPatch (diff-match-patch 0.0.2 API)

java.lang.Object
- fun.mike.dmp.DiffMatchPatch

```
public class DiffMatchPatch
extends java.lang.Object
```
Class containing the diff, match and patch methods. Also contains the behaviour settings.

Field Summary

Fields
Modifier and Type	Field and Description
`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 dmp (over ~64 characters), how close do the contents have to be to match the expected contents.
`short`	`Patch_Margin` Chunk size for context length.

Constructor Summary

Constructors
Constructor and Description

DiffMatchPatch()

Constructors
Constructor and Description
`DiffMatchPatch()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected java.util.LinkedList<Diff>`	`diff_bisect(java.lang.String text1, java.lang.String text2, long deadline)` Find the 'middle snake' of a diff, split the problem in two and return the recursively constructed diff.
`void`	`diff_charsToLines(java.util.LinkedList<Diff> diffs, java.util.List<java.lang.String> lineArray)` Rehydrate the dmp in a diff from a string of line hashes to real lines of dmp.
`void`	`diff_cleanupEfficiency(java.util.LinkedList<Diff> diffs)` Reduce the number of edits by eliminating operationally trivial equalities.
`void`	`diff_cleanupMerge(java.util.LinkedList<Diff> diffs)` Reorder and merge like edit sections.
`void`	`diff_cleanupSemanticLossless(java.util.LinkedList<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.
`protected int`	`diff_commonOverlap(java.lang.String text1, java.lang.String text2)` Determine if the suffix of one string is the prefix of another.
`protected java.lang.String[]`	`diff_halfMatch(java.lang.String text1, java.lang.String text2)` Do the two texts share a substring which is at least half the length of the longer dmp? This speedup can produce non-minimal diffs.
`int`	`diff_levenshtein(java.util.LinkedList<Diff> diffs)` Compute the Levenshtein distance; the number of inserted, deleted or substituted characters.
`java.util.LinkedList<Diff>`	`diff_lineMode(java.lang.String text1, java.lang.String text2, long deadline)` Do a quick line-level diff on both strings, then rediff the parts for greater accuracy.
`LinesToCharsResult`	`diff_linesToChars(java.lang.String text1, java.lang.String text2)` Split two texts into a list of strings.
`java.util.LinkedList<Diff>`	`diff_main(java.lang.String text1, java.lang.String text2)` Find the differences between two texts.
`java.util.LinkedList<Diff>`	`diff_main(java.lang.String text1, java.lang.String text2, boolean checklines)` Find the differences between two texts.
`java.lang.String`	`diff_text1(java.util.LinkedList<Diff> diffs)` Compute and return the source dmp (all equalities and deletions).
`java.lang.String`	`diff_text2(java.util.LinkedList<Diff> diffs)` Compute and return the destination dmp (all equalities and insertions).
`java.lang.String`	`diff_toDelta(java.util.LinkedList<Diff> diffs)` Crush the diff into an encoded string which describes the operations required to transform text1 into text2.
`int`	`diff_xIndex(java.util.LinkedList<Diff> diffs, int loc)` loc is a location in text1, compute and return the equivalent location in text2.
`void`	`diffCleanupSemantic(java.util.LinkedList<Diff> diffs)` Reduce the number of edits by eliminating semantically trivial equalities.
`int`	`diffCommonPrefix(java.lang.String text1, java.lang.String text2)` Determine the common prefix of two strings
`int`	`diffCommonSuffix(java.lang.String text1, java.lang.String text2)` Determine the common suffix of two strings
`java.util.LinkedList<Diff>`	`diffFromDelta(java.lang.String text1, java.lang.String delta)` Given the original text1, and an encoded string which describes the operations required to transform text1 into text2, compute the full diff.
`java.lang.String`	`diffPrettyHtml(java.util.LinkedList<Diff> diffs)` Convert a Diff list into a pretty HTML report.
`protected java.util.Map<java.lang.Character,java.lang.Integer>`	`match_alphabet(java.lang.String pattern)` Initialise the alphabet for the Bitap algorithm.
`protected int`	`match_bitap(java.lang.String text, java.lang.String pattern, int loc)` Locate the best instance of 'pattern' in 'dmp' near 'loc' using the Bitap algorithm.
`int`	`match_main(java.lang.String text, java.lang.String pattern, int loc)` Locate the best instance of 'pattern' in 'dmp' near 'loc'.
`protected void`	`patch_addContext(Patch patch, java.lang.String text)` Increase the context until it is unique, but don't let the pattern expand beyond Match_MaxBits.
`java.lang.String`	`patch_addPadding(java.util.LinkedList<Patch> patches)` Add some padding on dmp start and end so that edges can match something.
`java.lang.Object[]`	`patch_apply(java.util.LinkedList<Patch> patches, java.lang.String text)` Merge a set of patches onto the dmp.
`java.util.LinkedList<Patch>`	`patch_deepCopy(java.util.LinkedList<Patch> patches)` Given an array of patches, return another array that is identical.
`java.util.List<Patch>`	`patch_fromText(java.lang.String textline)` Parse a textual representation of patches and return a List of Patch objects.
`java.util.LinkedList<Patch>`	`patch_make(java.util.LinkedList<Diff> diffs)` Compute a list of patches to turn text1 into text2.
`java.util.LinkedList<Patch>`	`patch_make(java.lang.String text1, java.util.LinkedList<Diff> diffs)` Compute a list of patches to turn text1 into text2.
`java.util.LinkedList<Patch>`	`patch_make(java.lang.String text1, java.lang.String text2)` Compute a list of patches to turn text1 into text2.
`java.util.LinkedList<Patch>`	`patch_make(java.lang.String text1, java.lang.String text2, java.util.LinkedList<Diff> diffs)` Deprecated. Prefer patch_make(String text1, LinkedList<Diff> diffs).
`void`	`patch_splitMax(java.util.LinkedList<Patch> patches)` Look through the patches and break up any which are longer than the maximum limit of the match algorithm.
`java.lang.String`	`patch_toText(java.util.List<Patch> patches)` Take a list of patches and return a textual representation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - 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 dmp (over ~64 characters), how close do the contents have to be 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.
- Constructor Detail
  - DiffMatchPatch
```
public DiffMatchPatch()
```
- Method Detail
  - diff_main
```
public java.util.LinkedList<Diff> diff_main(java.lang.String text1,
                                            java.lang.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.
    
    Parameters:
    
    text1 - Old string to be diffed.
    
    text2 - New string to be diffed.
    
    Returns:
    
    Linked List of Diff objects.
  - diff_main
```
public java.util.LinkedList<Diff> diff_main(java.lang.String text1,
                                            java.lang.String text2,
                                            boolean checklines)
```
    Find the differences between two texts.
    
    Parameters:
    
    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.
    
    Returns:
    
    Linked List of Diff objects.
  - diff_lineMode
```
public java.util.LinkedList<Diff> diff_lineMode(java.lang.String text1,
                                                java.lang.String text2,
                                                long deadline)
```
    Do a quick line-level diff on both strings, then rediff the parts for greater accuracy. This speedup can produce non-minimal diffs.
    
    Parameters:
    
    text1 - Old string to be diffed.
    
    text2 - New string to be diffed.
    
    deadline - Time when the diff should be complete by.
    
    Returns:
    
    Linked List of Diff objects.
  - diff_bisect
```
protected java.util.LinkedList<Diff> diff_bisect(java.lang.String text1,
                                                 java.lang.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.
    
    Parameters:
    
    text1 - Old string to be diffed.
    
    text2 - New string to be diffed.
    
    deadline - Time at which to bail if not yet complete.
    
    Returns:
    
    LinkedList of Diff objects.
  - diff_linesToChars
```
public LinesToCharsResult diff_linesToChars(java.lang.String text1,
                                            java.lang.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.
    
    Parameters:
    
    text1 - First string.
    
    text2 - Second string.
    
    Returns:
    
    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
```
public void diff_charsToLines(java.util.LinkedList<Diff> diffs,
                              java.util.List<java.lang.String> lineArray)
```
    Rehydrate the dmp in a diff from a string of line hashes to real lines of dmp.
    
    Parameters:
    
    diffs - LinkedList of Diff objects.
    
    lineArray - List of unique strings.
  - diffCommonPrefix
```
public int diffCommonPrefix(java.lang.String text1,
                            java.lang.String text2)
```
    Determine the common prefix of two strings
    
    Parameters:
    
    text1 - First string.
    
    text2 - Second string.
    
    Returns:
    
    The number of characters common to the start of each string.
  - diffCommonSuffix
```
public int diffCommonSuffix(java.lang.String text1,
                            java.lang.String text2)
```
    Determine the common suffix of two strings
    
    Parameters:
    
    text1 - First string.
    
    text2 - Second string.
    
    Returns:
    
    The number of characters common to the end of each string.
  - diff_commonOverlap
```
protected int diff_commonOverlap(java.lang.String text1,
                                 java.lang.String text2)
```
    Determine if the suffix of one string is the prefix of another.
    
    Parameters:
    
    text1 - First string.
    
    text2 - Second string.
    
    Returns:
    
    The number of characters common to the end of the first string and the start of the second string.
  - diff_halfMatch
```
protected java.lang.String[] diff_halfMatch(java.lang.String text1,
                                            java.lang.String text2)
```
    Do the two texts share a substring which is at least half the length of the longer dmp? This speedup can produce non-minimal diffs.
    
    Parameters:
    
    text1 - First string.
    
    text2 - Second string.
    
    Returns:
    
    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.
  - diffCleanupSemantic
```
public void diffCleanupSemantic(java.util.LinkedList<Diff> diffs)
```
    Reduce the number of edits by eliminating semantically trivial equalities.
    
    Parameters:
    
    diffs - LinkedList of Diff objects.
  - diff_cleanupSemanticLossless
```
public void diff_cleanupSemanticLossless(java.util.LinkedList<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 c<ins>at c</ins>ame. -> The <ins>cat </ins>came.
    
    Parameters:
    
    diffs - LinkedList of Diff objects.
  - diff_cleanupEfficiency
```
public void diff_cleanupEfficiency(java.util.LinkedList<Diff> diffs)
```
    Reduce the number of edits by eliminating operationally trivial equalities.
    
    Parameters:
    
    diffs - LinkedList of Diff objects.
  - diff_cleanupMerge
```
public void diff_cleanupMerge(java.util.LinkedList<Diff> diffs)
```
    Reorder and merge like edit sections. Merge equalities. Any edit section can move as long as it doesn't cross an equality.
    
    Parameters:
    
    diffs - LinkedList of Diff objects.
  - diff_xIndex
```
public int diff_xIndex(java.util.LinkedList<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
    
    Parameters:
    
    diffs - LinkedList of Diff objects.
    
    loc - Location within text1.
    
    Returns:
    
    Location within text2.
  - diffPrettyHtml
```
public java.lang.String diffPrettyHtml(java.util.LinkedList<Diff> diffs)
```
    Convert a Diff list into a pretty HTML report.
    
    Parameters:
    
    diffs - LinkedList of Diff objects.
    
    Returns:
    
    HTML representation.
  - diff_text1
```
public java.lang.String diff_text1(java.util.LinkedList<Diff> diffs)
```
    Compute and return the source dmp (all equalities and deletions).
    
    Parameters:
    
    diffs - LinkedList of Diff objects.
    
    Returns:
    
    Source dmp.
  - diff_text2
```
public java.lang.String diff_text2(java.util.LinkedList<Diff> diffs)
```
    Compute and return the destination dmp (all equalities and insertions).
    
    Parameters:
    
    diffs - LinkedList of Diff objects.
    
    Returns:
    
    Destination dmp.
  - diff_levenshtein
```
public int diff_levenshtein(java.util.LinkedList<Diff> diffs)
```
    Compute the Levenshtein distance; the number of inserted, deleted or substituted characters.
    
    Parameters:
    
    diffs - LinkedList of Diff objects.
    
    Returns:
    
    Number of changes.
  - diff_toDelta
```
public java.lang.String diff_toDelta(java.util.LinkedList<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 dmp is escaped using %xx notation.
    
    Parameters:
    
    diffs - Array of Diff objects.
    
    Returns:
    
    Delta dmp.
  - diffFromDelta
```
public java.util.LinkedList<Diff> diffFromDelta(java.lang.String text1,
                                                java.lang.String delta)
                                         throws java.lang.IllegalArgumentException
```
    Given the original text1, and an encoded string which describes the operations required to transform text1 into text2, compute the full diff.
    
    Parameters:
    
    text1 - Source string for the diff.
    
    delta - Delta dmp.
    
    Returns:
    
    Array of Diff objects or null if invalid.
    
    Throws:
    
    java.lang.IllegalArgumentException - If invalid input.
  - match_main
```
public int match_main(java.lang.String text,
                      java.lang.String pattern,
                      int loc)
```
    Locate the best instance of 'pattern' in 'dmp' near 'loc'. Returns -1 if no match found.
    
    Parameters:
    
    text - The dmp to search.
    
    pattern - The pattern to search for.
    
    loc - The location to search around.
    
    Returns:
    
    Best match index or -1.
  - match_bitap
```
protected int match_bitap(java.lang.String text,
                          java.lang.String pattern,
                          int loc)
```
    Locate the best instance of 'pattern' in 'dmp' near 'loc' using the Bitap algorithm. Returns -1 if no match found.
    
    Parameters:
    
    text - The dmp to search.
    
    pattern - The pattern to search for.
    
    loc - The location to search around.
    
    Returns:
    
    Best match index or -1.
  - match_alphabet
```
protected java.util.Map<java.lang.Character,java.lang.Integer> match_alphabet(java.lang.String pattern)
```
    Initialise the alphabet for the Bitap algorithm.
    
    Parameters:
    
    pattern - The dmp to encode.
    
    Returns:
    
    Hash of character locations.
  - patch_addContext
```
protected void patch_addContext(Patch patch,
                                java.lang.String text)
```
    Increase the context until it is unique, but don't let the pattern expand beyond Match_MaxBits.
    
    Parameters:
    
    patch - The patch to grow.
    
    text - Source dmp.
  - patch_make
```
public java.util.LinkedList<Patch> patch_make(java.lang.String text1,
                                              java.lang.String text2)
```
    Compute a list of patches to turn text1 into text2. A set of diffs will be computed.
    
    Parameters:
    
    text1 - Old dmp.
    
    text2 - New dmp.
    
    Returns:
    
    LinkedList of Patch objects.
  - patch_make
```
public java.util.LinkedList<Patch> patch_make(java.util.LinkedList<Diff> diffs)
```
    Compute a list of patches to turn text1 into text2. text1 will be derived from the provided diffs.
    
    Parameters:
    
    diffs - Array of Diff objects for text1 to text2.
    
    Returns:
    
    LinkedList of Patch objects.
  - patch_make
```
public java.util.LinkedList<Patch> patch_make(java.lang.String text1,
                                              java.lang.String text2,
                                              java.util.LinkedList<Diff> diffs)
```
    Deprecated. Prefer patch_make(String text1, LinkedList<Diff> diffs).
    
    Compute a list of patches to turn text1 into text2. text2 is ignored, diffs are the delta between text1 and text2.
    
    Parameters:
    
    text1 - Old dmp
    
    text2 - Ignored.
    
    diffs - Array of Diff objects for text1 to text2.
    
    Returns:
    
    LinkedList of Patch objects.
  - patch_make
```
public java.util.LinkedList<Patch> patch_make(java.lang.String text1,
                                              java.util.LinkedList<Diff> diffs)
```
    Compute a list of patches to turn text1 into text2. text2 is not provided, diffs are the delta between text1 and text2.
    
    Parameters:
    
    text1 - Old dmp.
    
    diffs - Array of Diff objects for text1 to text2.
    
    Returns:
    
    LinkedList of Patch objects.
  - patch_deepCopy
```
public java.util.LinkedList<Patch> patch_deepCopy(java.util.LinkedList<Patch> patches)
```
    Given an array of patches, return another array that is identical.
    
    Parameters:
    
    patches - Array of Patch objects.
    
    Returns:
    
    Array of Patch objects.
  - patch_apply
```
public java.lang.Object[] patch_apply(java.util.LinkedList<Patch> patches,
                                      java.lang.String text)
```
    Merge a set of patches onto the dmp. Return a patched dmp, as well as an array of true/false values indicating which patches were applied.
    
    Parameters:
    
    patches - Array of Patch objects
    
    text - Old dmp.
    
    Returns:
    
    Two element Object array, containing the new dmp and an array of boolean values.
  - patch_addPadding
```
public java.lang.String patch_addPadding(java.util.LinkedList<Patch> patches)
```
    Add some padding on dmp start and end so that edges can match something. Intended to be called only from within patch_apply.
    
    Parameters:
    
    patches - Array of Patch objects.
    
    Returns:
    
    The padding string added to each side.
  - patch_splitMax
```
public void patch_splitMax(java.util.LinkedList<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.
    
    Parameters:
    
    patches - LinkedList of Patch objects.
  - patch_toText
```
public java.lang.String patch_toText(java.util.List<Patch> patches)
```
    Take a list of patches and return a textual representation.
    
    Parameters:
    
    patches - List of Patch objects.
    
    Returns:
    
    Text representation of patches.
  - patch_fromText
```
public java.util.List<Patch> patch_fromText(java.lang.String textline)
                                     throws java.lang.IllegalArgumentException
```
    Parse a textual representation of patches and return a List of Patch objects.
    
    Parameters:
    
    textline - Text representation of patches.
    
    Returns:
    
    List of Patch objects.
    
    Throws:
    
    java.lang.IllegalArgumentException - If invalid input.

Class DiffMatchPatch

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Diff_Timeout

Diff_EditCost

Match_Threshold

Match_Distance

Patch_DeleteThreshold

Patch_Margin

Constructor Detail

DiffMatchPatch

Method Detail

diff_main

diff_main

diff_lineMode

diff_bisect

diff_linesToChars

diff_charsToLines

diffCommonPrefix

diffCommonSuffix

diff_commonOverlap

diff_halfMatch

diffCleanupSemantic

diff_cleanupSemanticLossless

diff_cleanupEfficiency

diff_cleanupMerge

diff_xIndex

diffPrettyHtml

diff_text1

diff_text2

diff_levenshtein

diff_toDelta

diffFromDelta

match_main

match_bitap

match_alphabet

patch_addContext

patch_make

patch_make

patch_make

patch_make

patch_deepCopy

patch_apply

patch_addPadding

patch_splitMax

patch_toText

patch_fromText