com.github.difflib.text

Class DiffRowGenerator

java.lang.Object

com.github.difflib.text.DiffRowGenerator

public class DiffRowGenerator
extends 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.

Field Summary

Fields

Modifier and Type	Field and Description
static BiPredicate<String,String>	DEFAULT_EQUALIZER
static BiPredicate<String,String>	IGNORE_WHITESPACE_EQUALIZER
static Pattern	SPLIT_BY_WORD_PATTERN
static Function<String,List<String>>	SPLITTER_BY_CHARACTER Splitting lines by character to achieve char by char diff checking.
static Function<String,List<String>>	SPLITTER_BY_WORD Splitting lines by word to achieve word by word diff checking.

Method Summary

Modifier and Type	Method and Description
static DiffRowGenerator.Builder	create()
List<DiffRow>	generateDiffRows(List<String> original, List<String> revised) Get the DiffRows describing the difference between original and revised texts using the given patch.
List<DiffRow>	generateDiffRows(List<String> original, Patch<String> patch) Generates the DiffRows describing the difference between original and revised texts using the given patch.
protected static List<String>	splitStringPreserveDelimiter(String str, Pattern SPLIT_PATTERN)
static void	wrapInTag(List<String> sequence, int startPosition, int endPosition, Function<Boolean,String> generator) Wrap the elements in the sequence with the given tag

Methods inherited from class java.lang.Object

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

Field Detail

SPLIT_BY_WORD_PATTERN

public static final Pattern SPLIT_BY_WORD_PATTERN

IGNORE_WHITESPACE_EQUALIZER

public static final BiPredicate<String,String> IGNORE_WHITESPACE_EQUALIZER

DEFAULT_EQUALIZER

public static final BiPredicate<String,String> DEFAULT_EQUALIZER

SPLITTER_BY_WORD

public static final Function<String,List<String>> SPLITTER_BY_WORD

Splitting lines by word to achieve word by word diff checking.

SPLITTER_BY_CHARACTER

public static final Function<String,List<String>> SPLITTER_BY_CHARACTER

Splitting lines by character to achieve char by char diff checking.

Method Detail

create

public static DiffRowGenerator.Builder create()

generateDiffRows

public List<DiffRow> generateDiffRows(List<String> original,
                                      List<String> revised)
                               throws DiffException

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

Throws:

DiffException

generateDiffRows

public List<DiffRow> generateDiffRows(List<String> original,
                                      Patch<String> patch)
                               throws DiffException

Generates 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

patch - the given patch

Returns:

the DiffRows between original and revised texts

Throws:

DiffException

wrapInTag

public static void wrapInTag(List<String> sequence,
                             int startPosition,
                             int endPosition,
                             Function<Boolean,String> generator)

Wrap the elements in the sequence with the given tag

Parameters:

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

splitStringPreserveDelimiter

protected static final List<String> splitStringPreserveDelimiter(String str,
                                                                 Pattern SPLIT_PATTERN)