pw.prok.kdiff.delta

Class Delta<T>

java.lang.Object

pw.prok.kdiff.delta.Delta<T>

Type Parameters:

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

Direct Known Subclasses:

ChangeDelta, DeleteDelta, InsertDelta

public abstract class Delta<T>
extends java.lang.Object

Describes the delta between original and revised texts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Delta.DeltaType Specifies the type of the delta.

Constructor Summary

Constructors

Constructor and Description
Delta(Chunk<T> original, Chunk<T> revised) Construct the delta for original and revised chunks

Method Summary

Modifier and Type	Method and Description
abstract void	applyTo(java.util.List<T> target) Applies this delta as the patch for a given target
abstract Delta<T>	copy()
boolean	equals(java.lang.Object obj)
Chunk<T>	getOriginal()
Chunk<T>	getRevised()
abstract Delta.DeltaType	getType() Returns the type of delta
int	hashCode()
abstract void	restore(java.util.List<T> target) Cancel this delta for a given revised text.
void	setOriginal(Chunk<T> original)
void	setRevised(Chunk<T> revised)
abstract void	verify(java.util.List<T> target) Verifies that this delta can be used to patch the given text.

Methods inherited from class java.lang.Object

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

Constructor Detail

Delta

public Delta(Chunk<T> original,
             Chunk<T> revised)

Construct the delta for original and revised chunks

Parameters:

original - Chunk describing the original text. Must not be null.

revised - Chunk describing the revised text. Must not be null.

Method Detail

verify

public abstract void verify(java.util.List<T> target)
                     throws PatchFailedException

Verifies that this delta can be used to patch the given text.

Parameters:

target - the text to patch.

Throws:

PatchFailedException - if the patch cannot be applied.

applyTo

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

Applies this delta as the patch for a given target

Parameters:

target - the given target

Throws:

PatchFailedException - if the patch cannot be applied.

restore

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

Cancel this delta for a given revised text. The action is opposite to patch.

Parameters:

target - the given revised text

getType

public abstract Delta.DeltaType getType()

Returns the type of delta

Returns:

the type enum

getOriginal

public Chunk<T> getOriginal()

Returns:

The Chunk describing the original text.

setOriginal

public void setOriginal(Chunk<T> original)

Parameters:

original - The Chunk describing the original text to set.

getRevised

public Chunk<T> getRevised()

Returns:

The Chunk describing the revised text.

setRevised

public void setRevised(Chunk<T> revised)

Parameters:

revised - The Chunk describing the revised text to set.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

copy

public abstract Delta<T> copy()