pw.prok.kdiff.diff

Class DiffUtils

java.lang.Object

pw.prok.kdiff.diff.DiffUtils

public class DiffUtils
extends java.lang.Object

Implements the difference and patching engine

Constructor Summary

Constructors

Constructor and Description
DiffUtils()

Method Summary

Modifier and Type	Method and Description
static <T,R extends PatchResult<T>> Patch<T,R>	diff(java.util.List<T> original, java.util.List<T> revised) Computes the difference between the original and revised list of elements with default diff algorithm
static <T,R extends PatchResult<T>> Patch<T,R>	diff(java.util.List<T> original, java.util.List<T> revised, DiffAlgorithm<T,R> algorithm) Computes the difference between the original and revised list of elements with default diff algorithm
static <T,R extends PatchResult<T>> Patch<T,R>	diff(java.util.List<T> original, java.util.List<T> revised, Equalizer<T> equalizer) Computes the difference between the original and revised list of elements with default diff algorithm
static java.util.List<java.lang.String>	makeDiff(java.lang.String original, java.lang.String revised, java.util.List<java.lang.String> originalLines, Patch<java.lang.String,?> patch, int contextSize) makeDiff takes a Patch and some other arguments, returning the Unified Diff format text representing the Patch.
static Patch<java.lang.String,PatchResult<java.lang.String>>	parseDiff(java.util.List<java.lang.String> diff) Parse the given text in unified format and creates the patch for it.
static java.util.Map<Pair<java.lang.String,java.lang.String>,Patch<java.lang.String,PatchResult<java.lang.String>>>	parseUnifedDiff(java.util.List<java.lang.String> diff) Parse the given text in unified format and creates the patches for it.
static java.util.Map<Pair<java.lang.String,java.lang.String>,Patch<java.lang.String,PatchResult<java.lang.String>>>	parseUnifedDiff(java.util.List<java.lang.String> diff, java.util.Map<Pair<java.lang.String,java.lang.String>,Patch<java.lang.String,PatchResult<java.lang.String>>> map) Parse the given text in unified format and creates the patches for it.
static <T,R extends PatchResult<T>> R	patch(java.util.List<T> original, Patch<T,R> patch) Patch the original text with given patch
static <T,R extends PatchResult<T>> R	restore(java.util.List<T> revised, Patch<T,R> patch) RestoreВ the revised text for a given patch

Methods inherited from class java.lang.Object

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

Constructor Detail

DiffUtils

public DiffUtils()

Method Detail

diff

public static <T,R extends PatchResult<T>> Patch<T,R> diff(java.util.List<T> original,
                                                           java.util.List<T> revised)

Computes the difference between the original and revised list of elements with default diff algorithm

Type Parameters:

T - element type

R - patch result type

Parameters:

original - The original text. Must not be null.

revised - The revised text. Must not be null.

Returns:

The patch describing the difference between the original and revised sequences. Never null.

diff

public static <T,R extends PatchResult<T>> Patch<T,R> diff(java.util.List<T> original,
                                                           java.util.List<T> revised,
                                                           Equalizer<T> equalizer)

Computes the difference between the original and revised list of elements with default diff algorithm

Type Parameters:

T - element type

R - patch result type

Parameters:

original - The original text. Must not be null.

revised - The revised text. Must not be null.

equalizer - the equalizer object to replace the default compare algorithm (Object.equals). If null the default equalizer of the default algorithm is used..

Returns:

The patch describing the difference between the original and revised sequences. Never null.

diff

public static <T,R extends PatchResult<T>> Patch<T,R> diff(java.util.List<T> original,
                                                           java.util.List<T> revised,
                                                           DiffAlgorithm<T,R> algorithm)

Computes the difference between the original and revised list of elements with default diff algorithm

Type Parameters:

T - element type

R - patch result type

Parameters:

original - The original text. Must not be null.

revised - The revised text. Must not be null.

algorithm - The diff algorithm. Must not be null.

Returns:

The patch describing the difference between the original and revised sequences. Never null.

patch

public static <T,R extends PatchResult<T>> R patch(java.util.List<T> original,
                                                   Patch<T,R> patch)
                                            throws PatchFailedException

Patch the original text with given patch

Type Parameters:

T - element type

R - patch result type

Parameters:

original - the original text

patch - the given patch

Returns:

the revised text

Throws:

PatchFailedException - if can't apply patch

restore

public static <T,R extends PatchResult<T>> R restore(java.util.List<T> revised,
                                                     Patch<T,R> patch)

RestoreВ the revised text for a given patch

Type Parameters:

T - element type

R - patch result type

Parameters:

revised - the revised text

patch - the given patch

Returns:

the original text

parseDiff

public static Patch<java.lang.String,PatchResult<java.lang.String>> parseDiff(java.util.List<java.lang.String> diff)
                                                                       throws DiffException

Parse the given text in unified format and creates the patch for it. Supports only one diff in file. For multi-filed patches see parseUnifedDiff(List)

Parameters:

diff - the text in unified format

Returns:

the patch with deltas.

Throws:

DiffException - if patch cannot be patched

See Also:

parseUnifedDiff(List)

parseUnifedDiff

public static java.util.Map<Pair<java.lang.String,java.lang.String>,Patch<java.lang.String,PatchResult<java.lang.String>>> parseUnifedDiff(java.util.List<java.lang.String> diff)
                                                                                                                                    throws DiffException

Parse the given text in unified format and creates the patches for it.

Parameters:

diff - the text in unified format

Returns:

map of patches

Throws:

DiffException - if patch cannot be patched

See Also:

parseUnifedDiff(List, Map)

parseUnifedDiff

public static java.util.Map<Pair<java.lang.String,java.lang.String>,Patch<java.lang.String,PatchResult<java.lang.String>>> parseUnifedDiff(java.util.List<java.lang.String> diff,
                                                                                                                                           java.util.Map<Pair<java.lang.String,java.lang.String>,Patch<java.lang.String,PatchResult<java.lang.String>>> map)
                                                                                                                                    throws DiffException

Parse the given text in unified format and creates the patches for it.

Parameters:

diff - the text in unified format

map - starting map of patches

Returns:

map of patches

Throws:

DiffException - if patch cannot be patched

See Also:

parseUnifedDiff(List)

makeDiff

public static java.util.List<java.lang.String> makeDiff(java.lang.String original,
                                                        java.lang.String revised,
                                                        java.util.List<java.lang.String> originalLines,
                                                        Patch<java.lang.String,?> patch,
                                                        int contextSize)

makeDiff takes a Patch and some other arguments, returning the Unified Diff format text representing the Patch.

Parameters:

original - - Filename of the original (unrevised file)

revised - - Filename of the revised file

originalLines - - Lines of the original file

patch - - Patch created by the diff() function

contextSize - - number of lines of context output around each difference in the file.

Returns:

List of strings representing the Unified Diff representation of the Patch argument.