pw.prok.kdiff.diff

Class DiffRowGenerator

java.lang.Object

pw.prok.kdiff.diff.DiffRowGenerator

public class DiffRowGenerator
extends java.lang.Object

This class for generating DiffRows for side-by-sidy view. You can customize the way of generating. For example, show inline diffs on not, ignoring white spaces or/and blank lines and so on. All parameters for generating are optional. If you do not specify them, the class will use the default values.

These values are: showInlineDiffs = false; ignoreWhiteSpaces = true; ignoreBlankLines = true; ...

For instantiating the DiffRowGenerator you should use the its builder. Like in example DiffRowGenerator generator = new DiffRowGenerator.Builder().showInlineDiffs(true). ignoreWhiteSpaces(true).columnWidth(100).build();

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DiffRowGenerator.Builder This class used for building the DiffRowGenerator.

Method Summary

Modifier and Type	Method and Description
java.util.List<DiffRow>	generateDiffRows(java.util.List<java.lang.String> original, java.util.List<java.lang.String> revised) Get the DiffRows describing the difference between original and revised texts using the given patch.
<R extends PatchResult<java.lang.String>> java.util.List<DiffRow>	generateDiffRows(java.util.List<java.lang.String> original, java.util.List<java.lang.String> revised, Patch<java.lang.String,R> patch) Generates the DiffRows describing the difference between original and revised texts using the given patch.
static java.util.LinkedList<java.lang.String>	wrapInTag(java.util.LinkedList<java.lang.String> sequence, int startPosition, int endPosition, java.lang.String tag, java.lang.String cssClass) Wrap the elements in the sequence with the given tag
static java.lang.String	wrapInTag(java.lang.String line, java.lang.String tag, java.lang.String cssClass) Wrap the given line with the given tag

Methods inherited from class java.lang.Object

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

Method Detail

generateDiffRows

public java.util.List<DiffRow> generateDiffRows(java.util.List<java.lang.String> original,
                                                java.util.List<java.lang.String> revised)

Get the DiffRows describing the difference between original and revised texts using the given patch. Useful for displaying side-by-side diff.

Parameters:

original - the original text

revised - the revised text

Returns:

the DiffRows between original and revised texts

generateDiffRows

public <R extends PatchResult<java.lang.String>> java.util.List<DiffRow> generateDiffRows(java.util.List<java.lang.String> original,
                                                                                          java.util.List<java.lang.String> revised,
                                                                                          Patch<java.lang.String,R> patch)

Generates the DiffRows describing the difference between original and revised texts using the given patch. Useful for displaying side-by-side diff.

Type Parameters:

R - patch result type

Parameters:

original - the original text

revised - the revised text

patch - the given patch

Returns:

the DiffRows between original and revised texts

wrapInTag

public static java.util.LinkedList<java.lang.String> wrapInTag(java.util.LinkedList<java.lang.String> sequence,
                                                               int startPosition,
                                                               int endPosition,
                                                               java.lang.String tag,
                                                               java.lang.String cssClass)

Wrap the elements in the sequence with the given tag

Parameters:

sequence - the sequence

startPosition - the position from which tag should start. The counting start from a zero.

endPosition - the position before which tag should should be closed.

tag - the tag name without angle brackets, just a word

cssClass - the optional css class

Returns:

wrapped sequence

wrapInTag

public static java.lang.String wrapInTag(java.lang.String line,
                                         java.lang.String tag,
                                         java.lang.String cssClass)

Wrap the given line with the given tag

Parameters:

line - the given line

tag - the tag name without angle brackets, just a word

cssClass - the optional css class

Returns:

the wrapped string