Class Patch<T>

java.lang.Object

com.github.difflib.patch.Patch<T>

Type Parameters:

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

All Implemented Interfaces:

Serializable

public final class Patch<T>
extends Object
implements Serializable

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	Patch.PatchApplyingContext<T>

Field Summary

Fields

Modifier and Type	Field	Description
final ConflictOutput<T>	CONFLICT_PRODUCES_EXCEPTION	Standard Patch behaviour to throw an exception for pathching conflicts.
static final ConflictOutput<String>	CONFLICT_PRODUCES_MERGE_CONFLICT	Git like merge conflict output.
private ConflictOutput<T>	conflictOutput
private final List<AbstractDelta<T>>	deltas

Constructor Summary

Constructors

Constructor	Description
Patch()
Patch(int estimatedPatchSize)

Method Summary

Modifier and Type	Method	Description
void	addDelta(AbstractDelta<T> delta)	Add the given delta to this patch
List<T>	applyFuzzy(List<T> target, int maxFuzz)
List<T>	applyTo(List<? extends T> target)	Creates a new list, the patch is being applied to.
void	applyToExisting(List<T> target)	Applies the patch to the supplied list.
private static <T> Chunk<T>	buildChunk(int start, int end, List<? extends T> data)
private int	findPositionFuzzy(Patch.PatchApplyingContext<T> ctx, AbstractDelta<T> delta)
private int	findPositionWithFuzz(Patch.PatchApplyingContext<T> ctx, AbstractDelta<T> delta, int fuzz)
private int	findPositionWithFuzzAndMoreDelta(Patch.PatchApplyingContext<T> ctx, AbstractDelta<T> delta, int fuzz, int moreDelta)
static <T> Patch<T>	generate(List<? extends T> original, List<? extends T> revised, List<Change> _changes, boolean includeEquals)
static <T> Patch<T>	generate(List<T> original, List<T> revised, List<Change> changes)
List<AbstractDelta<T>>	getDeltas()	Get the list of computed deltas
List<T>	restore(List<? extends T> target)	Creates a new list, containing the restored state of the given list.
void	restoreToExisting(List<T> target)	Restores all changes within the given list.
String	toString()
Patch	withConflictOutput(ConflictOutput<T> conflictOutput)	Alter normal conflict output behaviour to e.g.

Methods inherited from class Object

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

Field Details

deltas

private final List<AbstractDelta<T>> deltas

CONFLICT_PRODUCES_EXCEPTION

public final ConflictOutput<T> CONFLICT_PRODUCES_EXCEPTION

Standard Patch behaviour to throw an exception for pathching conflicts.

CONFLICT_PRODUCES_MERGE_CONFLICT

public static final ConflictOutput<String> CONFLICT_PRODUCES_MERGE_CONFLICT

Git like merge conflict output.

conflictOutput

private ConflictOutput<T> conflictOutput

Constructor Details

Patch

public Patch()

Patch

public Patch(int estimatedPatchSize)

Method Details

applyTo

public List<T> applyTo(List<? extends T> target)
                throws PatchFailedException

Creates a new list, the patch is being applied to.

Parameters:

target - The list to apply the changes to.

Returns:

A new list containing the applied patch.

Throws:

PatchFailedException - if the patch cannot be applied

applyToExisting

public void applyToExisting(List<T> target)
                     throws PatchFailedException

Applies the patch to the supplied list.

Parameters:

target - The list to apply the changes to. This list has to be modifiable, otherwise exceptions may be thrown, depending on the used type of list.

Throws:

PatchFailedException - if the patch cannot be applied

RuntimeException - (or similar) if the list is not modifiable.

applyFuzzy

public List<T> applyFuzzy(List<T> target,
 int maxFuzz)
                   throws PatchFailedException

Throws:

PatchFailedException

findPositionFuzzy

private int findPositionFuzzy(Patch.PatchApplyingContext<T> ctx,
 AbstractDelta<T> delta)
                       throws PatchFailedException

Throws:

PatchFailedException

findPositionWithFuzz

private int findPositionWithFuzz(Patch.PatchApplyingContext<T> ctx,
 AbstractDelta<T> delta,
 int fuzz)
                          throws PatchFailedException

Throws:

PatchFailedException

findPositionWithFuzzAndMoreDelta

private int findPositionWithFuzzAndMoreDelta(Patch.PatchApplyingContext<T> ctx,
 AbstractDelta<T> delta,
 int fuzz,
 int moreDelta)
                                      throws PatchFailedException

Throws:

PatchFailedException

withConflictOutput

public Patch withConflictOutput(ConflictOutput<T> conflictOutput)

Alter normal conflict output behaviour to e.g. include some conflict statements in the result, like git does it.

restore

public List<T> restore(List<? extends T> target)

Creates a new list, containing the restored state of the given list. Opposite to applyTo(List) method.

Parameters:

target - The list to copy and apply changes to.

Returns:

A new list, containing the restored state.

restoreToExisting

public void restoreToExisting(List<T> target)

Restores all changes within the given list. Opposite to applyToExisting(List) method.

Parameters:

target - The list to restore changes in. This list has to be modifiable, otherwise exceptions may be thrown, depending on the used type of list.

Throws:

RuntimeException - (or similar) if the list is not modifiable.

addDelta

public void addDelta(AbstractDelta<T> delta)

Add the given delta to this patch

Parameters:

delta - the given delta

getDeltas

public List<AbstractDelta<T>> getDeltas()

Get the list of computed deltas

Returns:

the deltas

toString

public String toString()

Overrides:

toString in class Object

generate

public static <T> Patch<T> generate(List<T> original,
 List<T> revised,
 List<Change> changes)

buildChunk

private static <T> Chunk<T> buildChunk(int start,
 int end,
 List<? extends T> data)

generate

public static <T> Patch<T> generate(List<? extends T> original,
 List<? extends T> revised,
 List<Change> _changes,
 boolean includeEquals)