Package org.apache.commons.text.diff
Class EditScript<T>
- java.lang.Object
-
- org.apache.commons.text.diff.EditScript<T>
-
- Type Parameters:
T
- object type
public class EditScript<T> extends java.lang.Object
This class gathers all thecommands
needed to transform one objects sequence into another objects sequence.An edit script is the most general view of the differences between two sequences. It is built as the result of the comparison between two sequences by the
StringsComparator
class. The user can walk through it using the visitor design pattern.It is guaranteed that the objects embedded in the
insert commands
come from the second sequence and that the objects embedded in either thedelete commands
orkeep commands
come from the first sequence. This can be important if subclassing is used for some elements in the first sequence and theequals
method is specialized.- Since:
- 1.0
- See Also:
StringsComparator
,EditCommand
,CommandVisitor
,ReplacementsHandler
-
-
Constructor Summary
Constructors Constructor Description EditScript()
Constructs a new empty script.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
append(DeleteCommand<T> command)
Appends a delete command to the script.void
append(InsertCommand<T> command)
Appends an insert command to the script.void
append(KeepCommand<T> command)
Appends a keep command to the script.int
getLCSLength()
Gets the length of the Longest Common Subsequence (LCS).int
getModifications()
Gets the number of effective modifications.void
visit(CommandVisitor<T> visitor)
Visits the script.
-
-
-
Method Detail
-
append
public void append(DeleteCommand<T> command)
Appends a delete command to the script.- Parameters:
command
- command to add
-
append
public void append(InsertCommand<T> command)
Appends an insert command to the script.- Parameters:
command
- command to add
-
append
public void append(KeepCommand<T> command)
Appends a keep command to the script.- Parameters:
command
- command to add
-
getLCSLength
public int getLCSLength()
Gets the length of the Longest Common Subsequence (LCS). The length of the longest common subsequence is the number ofkeep commands
in the script.- Returns:
- length of the Longest Common Subsequence
-
getModifications
public int getModifications()
Gets the number of effective modifications. The number of effective modification is the number ofdelete
andinsert
commands in the script.- Returns:
- number of effective modifications
-
visit
public void visit(CommandVisitor<T> visitor)
Visits the script. The script implements the visitor design pattern, this method is the entry point to which the user supplies its own visitor, the script will be responsible to drive it through the commands in order and call the appropriate method as each command is encountered.- Parameters:
visitor
- the visitor that will visit all commands in turn
-
-