com.github.difflib.text

Class DiffRowGenerator

java.lang.Object

com.github.difflib.text.DiffRowGenerator

public final 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.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
static DiffRowGenerator.Builder	create()
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.
java.util.List<DiffRow>	generateDiffRows(java.util.List<java.lang.String> original, Patch<java.lang.String> patch) Generates the DiffRows describing the difference between original and revised texts using the given patch.
protected static java.util.List<java.lang.String>	splitStringPreserveDelimiter(java.lang.String str, java.util.regex.Pattern SPLIT_PATTERN)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EQUALIZER

public static final java.util.function.BiPredicate<java.lang.String,java.lang.String> DEFAULT_EQUALIZER

IGNORE_WHITESPACE_EQUALIZER

public static final java.util.function.BiPredicate<java.lang.String,java.lang.String> IGNORE_WHITESPACE_EQUALIZER

LINE_NORMALIZER_FOR_HTML

public static final java.util.function.Function<java.lang.String,java.lang.String> LINE_NORMALIZER_FOR_HTML

SPLITTER_BY_CHARACTER

public static final java.util.function.Function<java.lang.String,java.util.List<java.lang.String>> SPLITTER_BY_CHARACTER

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

SPLIT_BY_WORD_PATTERN

public static final java.util.regex.Pattern SPLIT_BY_WORD_PATTERN

SPLITTER_BY_WORD

public static final java.util.function.Function<java.lang.String,java.util.List<java.lang.String>> SPLITTER_BY_WORD

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

WHITESPACE_PATTERN

public static final java.util.regex.Pattern WHITESPACE_PATTERN

Method Detail

create

public static DiffRowGenerator.Builder create()

splitStringPreserveDelimiter

protected static final java.util.List<java.lang.String> splitStringPreserveDelimiter(java.lang.String str,
                                                                                     java.util.regex.Pattern SPLIT_PATTERN)

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 java.util.List<DiffRow> generateDiffRows(java.util.List<java.lang.String> original,
                                                Patch<java.lang.String> patch)

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

patch - the given patch

Returns:

the DiffRows between original and revised texts