com.liferay.portal.kernel.diff

Class DiffUtil

java.lang.Object

com.liferay.portal.kernel.diff.DiffUtil

Direct Known Subclasses:

DiffUtil

public class DiffUtil
extends java.lang.Object

This class can compare two different versions of a text. Source refers to the earliest version of the text and target refers to a modified version of source. Changes are considered either as a removal from the source or as an addition to the target. This class detects changes to an entire line and also detects changes within lines, such as, removal or addition of characters. Take a look at DiffTest to see the expected inputs and outputs.

Author:

Bruno Farache

See Also:

DiffUtil

Constructor Summary

Constructors

Constructor and Description
DiffUtil()

Method Summary

Modifier and Type	Method and Description
static java.util.List<DiffResult>[]	diff(java.io.Reader source, java.io.Reader target) This is a diff method with default values.
static java.util.List<DiffResult>[]	diff(java.io.Reader source, java.io.Reader target, java.lang.String addedMarkerStart, java.lang.String addedMarkerEnd, java.lang.String deletedMarkerStart, java.lang.String deletedMarkerEnd, int margin) The main entrance of this class.
static Diff	getDiff()
void	setDiff(Diff diff)

Methods inherited from class java.lang.Object

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

Constructor Detail

DiffUtil

public DiffUtil()

Method Detail

diff

public static java.util.List<DiffResult>[] diff(java.io.Reader source,
                                                java.io.Reader target)

This is a diff method with default values.

Parameters:

source - the source text

target - the modified version of the source text

Returns:

an array containing two lists of DiffResults, the first element contains DiffResults related to changes in source and the second element to changes in target

diff

public static java.util.List<DiffResult>[] diff(java.io.Reader source,
                                                java.io.Reader target,
                                                java.lang.String addedMarkerStart,
                                                java.lang.String addedMarkerEnd,
                                                java.lang.String deletedMarkerStart,
                                                java.lang.String deletedMarkerEnd,
                                                int margin)

The main entrance of this class. This method will compare the two texts, highlight the changes by enclosing them with markers and return a list of DiffResults.

Parameters:

source - the source text

target - the modified version of the source text

addedMarkerStart - the marker to indicate the start of text added to the source

addedMarkerEnd - the marker to indicate the end of text added to the source

deletedMarkerStart - the marker to indicate the start of text deleted from the source

deletedMarkerEnd - the marker to indicate the end of text deleted from the source

margin - the vertical margin to use in displaying differences between changed line changes

Returns:

an array containing two lists of DiffResults, the first element contains DiffResults related to changes in source and the second element to changes in target

getDiff

public static Diff getDiff()

setDiff

public void setDiff(Diff diff)