pw.prok.kdiff

Class Patch<T,R extends PatchResult<T>>

java.lang.Object

pw.prok.kdiff.Patch<T,R>

Type Parameters:

T - The type of the compared elements in the 'lines'.

public class Patch<T,R extends PatchResult<T>>
extends java.lang.Object

Describes the patch holding all deltas between the original and revised texts.

Constructor Summary

Constructors

Constructor and Description
Patch()
Patch(java.util.List<Delta<T>> deltas)

Method Summary

Modifier and Type	Method and Description
void	addDelta(Delta<T> delta) Add the given delta to this patch
R	applyTo(java.util.List<T> target) Apply this patch to the given target
Patch<T,R>	copy()
protected Patch<T,R>	createEmpty(java.util.List<Delta<T>> deltas) Internal method of Patch class.
protected R	createResult(java.util.List<T> result) Internal method of Patch class.
java.util.List<Delta<T>>	getDeltas() Get the list of computed deltas
java.lang.String	getOriginal()
java.util.Date	getOriginalDate()
java.lang.String	getRevised()
java.util.Date	getRevisedDate()
Patch<T,R>	merge(Patch<T,R> patch) Chain of copy() and mergeSelf(Patch).
Patch<T,R>	mergeSelf(Patch<T,R> patch) Merges into self deltas from other patch
R	restore(java.util.List<T> target) Restore the text to original.
Patch<T,R>	setOriginal(java.lang.String original)
Patch	setOriginalDate(java.util.Date originalDate)
Patch<T,R>	setRevised(java.lang.String revised)
Patch	setRevisedDate(java.util.Date revisedDate)

Methods inherited from class java.lang.Object

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

Constructor Detail

Patch

public Patch()

Patch

public Patch(java.util.List<Delta<T>> deltas)

Method Detail

createResult

protected R createResult(java.util.List<T> result)

Internal method of Patch class. Should be overriden in case of different result class

Parameters:

result - final result of patchin/rolling

Returns:

PatchResult instance

applyTo

public R applyTo(java.util.List<T> target)
          throws PatchFailedException

Apply this patch to the given target

Parameters:

target - list of target elements

Returns:

the patched text

Throws:

PatchFailedException - if can't apply patch

restore

public R restore(java.util.List<T> target)

Restore the text to original. Opposite to applyTo() method.

Parameters:

target - the given target

Returns:

the restored text

addDelta

public void addDelta(Delta<T> delta)

Add the given delta to this patch

Parameters:

delta - the given delta

getDeltas

public java.util.List<Delta<T>> getDeltas()

Get the list of computed deltas

Returns:

the deltas

createEmpty

protected Patch<T,R> createEmpty(java.util.List<Delta<T>> deltas)

Internal method of Patch class. Creates new patch container

Parameters:

deltas - initial list of deltas

Returns:

new patch instance

copy

public Patch<T,R> copy()

Returns:

a deep copy of this patch

mergeSelf

public Patch<T,R> mergeSelf(Patch<T,R> patch)

Merges into self deltas from other patch

Parameters:

patch - patch to merge

Returns:

this

merge

public Patch<T,R> merge(Patch<T,R> patch)

Chain of copy() and mergeSelf(Patch).

Parameters:

patch - patch to merge

Returns:

new patch, which are contains all deltas

getOriginal

public java.lang.String getOriginal()

Returns:

original file name

setOriginal

public Patch<T,R> setOriginal(java.lang.String original)

Parameters:

original - new original file name

Returns:

patch instance

getOriginalDate

public java.util.Date getOriginalDate()

setOriginalDate

public Patch setOriginalDate(java.util.Date originalDate)

getRevised

public java.lang.String getRevised()

Returns:

revised file name

setRevised

public Patch<T,R> setRevised(java.lang.String revised)

Parameters:

revised - new revised file name

Returns:

patch instance

getRevisedDate

public java.util.Date getRevisedDate()

setRevisedDate

public Patch setRevisedDate(java.util.Date revisedDate)