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

Modifier and Type	Field and Description
private final int	columnWidth
private final boolean	decompressDeltas
public static final BiPredicate<String, String>	DEFAULT_EQUALIZER
private final BiPredicate<String, String>	equalizer
public static final BiPredicate<String, String>	IGNORE_WHITESPACE_EQUALIZER
private final boolean	ignoreWhiteSpaces
private final Function<String, List<String>>	inlineDiffSplitter
public static final Function<String, String>	LINE_NORMALIZER_FOR_HTML
private final Function<String, String>	lineNormalizer
private final boolean	mergeOriginalRevised
private final BiFunction<DiffRow.Tag, Boolean, String>	newTag
private final BiFunction<DiffRow.Tag, Boolean, String>	oldTag
private final Function<String, String>	processDiffs
private final boolean	replaceOriginalLinefeedInChangesWithSpaces
private final boolean	reportLinesUnchanged
private final boolean	showInlineDiffs
public static final Pattern	SPLIT_BY_WORD_PATTERN
public static final Function<String, List<String>>	SPLITTER_BY_CHARACTER Splitting lines by character to achieve char by char diff checking.
public static final Function<String, List<String>>	SPLITTER_BY_WORD Splitting lines by word to achieve word by word diff checking.
public static final Pattern	WHITESPACE_PATTERN

Access	Constructor and Description
private	DiffRowGenerator(DiffRowGenerator.Builder builder)

Method Summary

Modifier and Type	Method and Description
private static String	adjustWhitespace(String raw)
private DiffRow	buildDiffRow(DiffRow.Tag type, String orgline, String newline)
private DiffRow	buildDiffRowWithoutNormalizing(DiffRow.Tag type, String orgline, String newline)
public static DiffRowGenerator.Builder	create()
private List<AbstractDelta<String>>	decompressDeltas(AbstractDelta<String> delta) Decompresses ChangeDeltas with different source and target size to a ChangeDelta with same size and a following InsertDelta or DeleteDelta.
public List<DiffRow>	Returns: the DiffRows between original and revised texts generateDiffRows(List<String> the original text original, List<String> the revised text revised) Get the DiffRows describing the difference between original and revised texts using the given patch.
public List<DiffRow>	Returns: the DiffRows between original and revised texts generateDiffRows(final List<String> the original text original, Patch<String> the given patch patch) Generates the DiffRows describing the difference between original and revised texts using the given patch.
private List<DiffRow>	generateInlineDiffs(AbstractDelta<String> the given delta delta) Add the inline diffs for given delta
pack-priv List<String>	normalizeLines(List<String> list)
private String	preprocessLine(String line)
protected static final List<String>	splitStringPreserveDelimiter(String str, Pattern SPLIT_PATTERN)
private int	transformDeltaIntoDiffRow(final List<String> original, int endPos, List<DiffRow> diffRows, AbstractDelta<String> delta) Transforms one patch delta into a DiffRow object.
pack-priv static void	wrapInTag(List<String> sequence, int the position from which tag should start. The counting start from a zero. startPosition, int the position before which tag should should be closed. endPosition, DiffRow.Tag tag, BiFunction<DiffRow.Tag, Boolean, String> the tag generator tagGenerator, Function<String, String> processDiffs, boolean replaceLinefeedWithSpace) Wrap the elements in the sequence with the given tag

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

columnWidth	back to summary
private final int columnWidth

decompressDeltas	back to summary
private final boolean decompressDeltas

DEFAULT_EQUALIZER	back to summary
public static final BiPredicate<String, String> DEFAULT_EQUALIZER

equalizer	back to summary
private final BiPredicate<String, String> equalizer

IGNORE_WHITESPACE_EQUALIZER	back to summary
public static final BiPredicate<String, String> IGNORE_WHITESPACE_EQUALIZER

ignoreWhiteSpaces	back to summary
private final boolean ignoreWhiteSpaces

inlineDiffSplitter	back to summary
private final Function<String, List<String>> inlineDiffSplitter

LINE_NORMALIZER_FOR_HTML	back to summary
public static final Function<String, String> LINE_NORMALIZER_FOR_HTML

lineNormalizer	back to summary
private final Function<String, String> lineNormalizer

mergeOriginalRevised	back to summary
private final boolean mergeOriginalRevised

newTag	back to summary
private final BiFunction<DiffRow.Tag, Boolean, String> newTag

oldTag	back to summary
private final BiFunction<DiffRow.Tag, Boolean, String> oldTag

processDiffs	back to summary
private final Function<String, String> processDiffs

replaceOriginalLinefeedInChangesWithSpaces	back to summary
private final boolean replaceOriginalLinefeedInChangesWithSpaces

reportLinesUnchanged	back to summary
private final boolean reportLinesUnchanged

showInlineDiffs	back to summary
private final boolean showInlineDiffs

SPLIT_BY_WORD_PATTERN	back to summary
public static final Pattern SPLIT_BY_WORD_PATTERN

SPLITTER_BY_CHARACTER	back to summary
public static final Function<String, List<String>> SPLITTER_BY_CHARACTER Splitting lines by character to achieve char by char diff checking.

SPLITTER_BY_WORD	back to summary
public static final Function<String, List<String>> SPLITTER_BY_WORD Splitting lines by word to achieve word by word diff checking.

WHITESPACE_PATTERN	back to summary
public static final Pattern WHITESPACE_PATTERN

DiffRowGenerator	back to summary
private DiffRowGenerator(DiffRowGenerator.Builder builder)

Method Detail

adjustWhitespace	back to summary
private static String adjustWhitespace(String raw)

buildDiffRow	back to summary
private DiffRow buildDiffRow(DiffRow.Tag type, String orgline, String newline)

buildDiffRowWithoutNormalizing	back to summary
private DiffRow buildDiffRowWithoutNormalizing(DiffRow.Tag type, String orgline, String newline)

create	back to summary
public static DiffRowGenerator.Builder create()

decompressDeltas	back to summary
private List<AbstractDelta<String>> decompressDeltas(AbstractDelta<String> delta) Decompresses ChangeDeltas with different source and target size to a ChangeDelta with same size and a following InsertDelta or DeleteDelta. With this problems of building DiffRows getting smaller.

generateDiffRows	back to summary
public List<DiffRow> generateDiffRows(List<String> original, List<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:List<String> the original text revised:List<String> the revised text Returns:List<DiffRow> the DiffRows between original and revised texts

generateDiffRows

back to summary

public List<DiffRow> generateDiffRows(List<String> original, List<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:List<String>: the original text
revised:List<String>: the revised text

Returns:List<DiffRow>

the DiffRows between original and revised texts

generateDiffRows	back to summary
public List<DiffRow> generateDiffRows(final List<String> original, Patch<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:List<String> the original text patch:Patch<String> the given patch Returns:List<DiffRow> the DiffRows between original and revised texts

generateDiffRows

back to summary

public List<DiffRow> generateDiffRows(final List<String> original, Patch<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:List<String>: the original text
patch:Patch<String>: the given patch

Returns:List<DiffRow>

the DiffRows between original and revised texts

generateInlineDiffs	back to summary
private List<DiffRow> generateInlineDiffs(AbstractDelta<String> delta) Add the inline diffs for given delta Parameters delta:AbstractDelta<String> the given delta

generateInlineDiffs

back to summary

private List<DiffRow> generateInlineDiffs(AbstractDelta<String> delta)

Add the inline diffs for given delta

Parameters

delta:AbstractDelta<String>: the given delta

normalizeLines	back to summary
pack-priv List<String> normalizeLines(List<String> list)

preprocessLine	back to summary
private String preprocessLine(String line)

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

transformDeltaIntoDiffRow	back to summary
private int transformDeltaIntoDiffRow(final List<String> original, int endPos, List<DiffRow> diffRows, AbstractDelta<String> delta) Transforms one patch delta into a DiffRow object.

wrapInTag	back to summary
pack-priv static void wrapInTag(List<String> sequence, int startPosition, int endPosition, DiffRow.Tag tag, BiFunction<DiffRow.Tag, Boolean, String> tagGenerator, Function<String, String> processDiffs, boolean replaceLinefeedWithSpace) Wrap the elements in the sequence with the given tag Parameters startPosition:int the position from which tag should start. The counting start from a zero. endPosition:int the position before which tag should should be closed. tagGenerator:BiFunction<DiffRow.Tag, Boolean, String> the tag generator

wrapInTag

back to summary

pack-priv static void wrapInTag(List<String> sequence, int startPosition, int endPosition, DiffRow.Tag tag, BiFunction<DiffRow.Tag, Boolean, String> tagGenerator, Function<String, String> processDiffs, boolean replaceLinefeedWithSpace)

Wrap the elements in the sequence with the given tag

Parameters

startPosition:int: the position from which tag should start. The counting start from a zero.
endPosition:int: the position before which tag should should be closed.
tagGenerator:BiFunction<DiffRow.Tag, Boolean, String>: the tag generator

com.github.difflib.text back to summary

public Class DiffRowGenerator.Builder

Class Inheritance

extends Object

java.lang.Object
com.github.difflib.text.DiffRowGenerator.Builder

This class used for building the DiffRowGenerator.

Author: dmitry

Field Summary

Modifier and Type	Field and Description
private int	columnWidth
private boolean	decompressDeltas
private BiPredicate<String, String>	equalizer
private boolean	ignoreWhiteSpaces
private Function<String, List<String>>	inlineDiffSplitter
private Function<String, String>	lineNormalizer
private boolean	mergeOriginalRevised
private BiFunction<DiffRow.Tag, Boolean, String>	newTag
private BiFunction<DiffRow.Tag, Boolean, String>	oldTag
private Function<String, String>	processDiffs
private boolean	replaceOriginalLinefeedInChangesWithSpaces
private boolean	reportLinesUnchanged
private boolean	showInlineDiffs

Constructor Summary

Access	Constructor and Description
private	Builder()

Method Summary

Modifier and Type	Method and Description
public DiffRowGenerator	Returns: the customized DiffRowGenerator build() Build the DiffRowGenerator.
public DiffRowGenerator.Builder	Returns: builder with config of column width columnWidth(int the width to set. Making it < 0 doesn't make any sense. Default 80. width) Set the column width of generated lines of original and revised texts.
public DiffRowGenerator.Builder	decompressDeltas(boolean decompressDeltas) Deltas could be in a state, that would produce some unreasonable results within an inline diff.
public DiffRowGenerator.Builder	Returns: builder with configured equalizer parameter equalizer(BiPredicate<String, String> equalizer for diff processing. equalizer) Provide an equalizer for diff processing.
public DiffRowGenerator.Builder	Returns: builder with configured ignoreWhiteSpaces parameter ignoreWhiteSpaces(boolean the value to set. Default: true. val) Ignore white spaces in generating diff rows or not.
public DiffRowGenerator.Builder	inlineDiffBySplitter(Function<String, List<String>> inlineDiffSplitter) To provide some customized splitting a splitter can be provided.
public DiffRowGenerator.Builder	inlineDiffByWord(boolean inlineDiffByWord) Per default each character is separatly processed.
public DiffRowGenerator.Builder	lineNormalizer(Function<String, String> lineNormalizer) By default DiffRowGenerator preprocesses lines for HTML output.
public DiffRowGenerator.Builder	mergeOriginalRevised(boolean mergeOriginalRevised) Merge the complete result within the original text.
public DiffRowGenerator.Builder	newTag(BiFunction<DiffRow.Tag, Boolean, String> generator) Generator for New-Text-Tags.
public DiffRowGenerator.Builder	newTag(Function<Boolean, String> generator) Generator for New-Text-Tags.
public DiffRowGenerator.Builder	Returns: builder with configured ignoreBlankLines parameter oldTag(BiFunction<DiffRow.Tag, Boolean, String> the tag generator generator) Generator for Old-Text-Tags.
public DiffRowGenerator.Builder	Returns: builder with configured ignoreBlankLines parameter oldTag(Function<Boolean, String> the tag generator generator) Generator for Old-Text-Tags.
public DiffRowGenerator.Builder	processDiffs(Function<String, String> processDiffs) Processor for diffed text parts.
public DiffRowGenerator.Builder	replaceOriginalLinefeedInChangesWithSpaces(boolean replace) Sometimes it happens that a change contains multiple lines.
public DiffRowGenerator.Builder	Returns: builder with configured reportLinesUnchanged parameter reportLinesUnchanged(final boolean the value to set. Default: false. val) Report all lines without markup on the old or new text.
public DiffRowGenerator.Builder	Returns: builder with configured showInlineDiff parameter showInlineDiffs(boolean the value to set. Default: false. val) Show inline diffs in generating diff rows or not.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

columnWidth	back to summary
private int columnWidth

decompressDeltas	back to summary
private boolean decompressDeltas

equalizer	back to summary
private BiPredicate<String, String> equalizer

ignoreWhiteSpaces	back to summary
private boolean ignoreWhiteSpaces

inlineDiffSplitter	back to summary
private Function<String, List<String>> inlineDiffSplitter

lineNormalizer	back to summary
private Function<String, String> lineNormalizer

mergeOriginalRevised	back to summary
private boolean mergeOriginalRevised

newTag	back to summary
private BiFunction<DiffRow.Tag, Boolean, String> newTag

oldTag	back to summary
private BiFunction<DiffRow.Tag, Boolean, String> oldTag

processDiffs	back to summary
private Function<String, String> processDiffs

replaceOriginalLinefeedInChangesWithSpaces	back to summary
private boolean replaceOriginalLinefeedInChangesWithSpaces

reportLinesUnchanged	back to summary
private boolean reportLinesUnchanged

showInlineDiffs	back to summary
private boolean showInlineDiffs

Constructor Detail

Builder	back to summary
private Builder()

Method Detail

build

back to summary

public DiffRowGenerator build()

Build the DiffRowGenerator. If some parameters is not set, the default values are used.

Returns:DiffRowGenerator: the customized DiffRowGenerator

columnWidth

back to summary

public DiffRowGenerator.Builder columnWidth(int width)

Set the column width of generated lines of original and revised texts.

Parameters

width:int: the width to set. Making it < 0 doesn't make any sense. Default 80.

Returns:DiffRowGenerator.Builder

builder with config of column width

decompressDeltas	back to summary
public DiffRowGenerator.Builder decompressDeltas(boolean decompressDeltas) Deltas could be in a state, that would produce some unreasonable results within an inline diff. So the deltas are decompressed into smaller parts and rebuild. But this could result in more differences.

equalizer

back to summary

public DiffRowGenerator.Builder equalizer(BiPredicate<String, String> equalizer)

Provide an equalizer for diff processing.

Parameters

equalizer:BiPredicate<String, String>: equalizer for diff processing.

Returns:DiffRowGenerator.Builder

builder with configured equalizer parameter

ignoreWhiteSpaces

back to summary

public DiffRowGenerator.Builder ignoreWhiteSpaces(boolean val)

Ignore white spaces in generating diff rows or not.

Parameters

val:boolean: the value to set. Default: true.

Returns:DiffRowGenerator.Builder

builder with configured ignoreWhiteSpaces parameter

inlineDiffBySplitter	back to summary
public DiffRowGenerator.Builder inlineDiffBySplitter(Function<String, List<String>> inlineDiffSplitter) To provide some customized splitting a splitter can be provided. Here someone could think about sentence splitter, comma splitter or stuff like that.

inlineDiffByWord

back to summary

public DiffRowGenerator.Builder inlineDiffByWord(boolean inlineDiffByWord)

Per default each character is separatly processed. This variant introduces processing by word, which does not deliver in word changes. Therefore the whole word will be tagged as changed:

false:    (aBa : aba) --  changed: a(B)a : a(b)a
true:     (aBa : aba) --  changed: (aBa) : (aba)

lineNormalizer	back to summary
public DiffRowGenerator.Builder lineNormalizer(Function<String, String> lineNormalizer) By default DiffRowGenerator preprocesses lines for HTML output. Tabs and special HTML characters like "<" are replaced with its encoded value. To change this you can provide a customized line normalizer here.

mergeOriginalRevised	back to summary
public DiffRowGenerator.Builder mergeOriginalRevised(boolean mergeOriginalRevised) Merge the complete result within the original text. This makes sense for one line display.

newTag	back to summary
public DiffRowGenerator.Builder newTag(BiFunction<DiffRow.Tag, Boolean, String> generator) Generator for New-Text-Tags.

newTag	back to summary
public DiffRowGenerator.Builder newTag(Function<Boolean, String> generator) Generator for New-Text-Tags.

oldTag

back to summary

public DiffRowGenerator.Builder oldTag(BiFunction<DiffRow.Tag, Boolean, String> generator)

Generator for Old-Text-Tags.

Parameters

generator:BiFunction<DiffRow.Tag, Boolean, String>: the tag generator

Returns:DiffRowGenerator.Builder

builder with configured ignoreBlankLines parameter

oldTag

back to summary

public DiffRowGenerator.Builder oldTag(Function<Boolean, String> generator)

Generator for Old-Text-Tags.

Parameters

generator:Function<Boolean, String>: the tag generator

Returns:DiffRowGenerator.Builder

builder with configured ignoreBlankLines parameter

processDiffs	back to summary
public DiffRowGenerator.Builder processDiffs(Function<String, String> processDiffs) Processor for diffed text parts. Here e.g. whitecharacters could be replaced by something visible.

replaceOriginalLinefeedInChangesWithSpaces	back to summary
public DiffRowGenerator.Builder replaceOriginalLinefeedInChangesWithSpaces(boolean replace) Sometimes it happens that a change contains multiple lines. If there is no correspondence in old and new. To keep the merged line more readable the linefeeds could be replaced by spaces.

reportLinesUnchanged

back to summary

public DiffRowGenerator.Builder reportLinesUnchanged(final boolean val)

Report all lines without markup on the old or new text.

Parameters

val:boolean: the value to set. Default: false.

Returns:DiffRowGenerator.Builder

builder with configured reportLinesUnchanged parameter

showInlineDiffs

back to summary

public DiffRowGenerator.Builder showInlineDiffs(boolean val)

Show inline diffs in generating diff rows or not.

Parameters

val:boolean: the value to set. Default: false.

Returns:DiffRowGenerator.Builder

builder with configured showInlineDiff parameter

public final Class DiffRowGenerator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class DiffRowGenerator.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail