com.liferay.portal.util
Class DiffImpl

java.lang.Object
  com.liferay.portal.util.DiffImpl

All Implemented Interfaces:

Diff

public class DiffImpl
extends Object
implements Diff

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.

Field Summary

Fields inherited from interface com.liferay.portal.kernel.util.Diff

CLOSE_DEL, CLOSE_INS, CONTEXT_LINE, OPEN_DEL, OPEN_INS

Constructor Summary

DiffImpl()

Method Summary

List<DiffResult>[]	diff(Reader source, Reader target) This is a diff method with default values.
List<DiffResult>[]	diff(Reader source, Reader target, String addedMarkerStart, String addedMarkerEnd, String deletedMarkerStart, String deletedMarkerEnd, int margin) The main entrance of this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiffImpl

public DiffImpl()

Method Detail

diff

public List<DiffResult>[] diff(Reader source,
                               Reader target)

This is a diff method with default values.

Specified by:

diff in interface Diff

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 List<DiffResult>[] diff(Reader source,
                               Reader target,
                               String addedMarkerStart,
                               String addedMarkerEnd,
                               String deletedMarkerStart,
                               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.

Specified by:

diff in interface Diff

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