Javadoc

Author: garydgregory

src/main/java/org/apache/commons/text/diff/CommandVisitor.java

@@ -125,21 +125,21 @@ public interface CommandVisitor<T> {
     /**
      * Method called when a delete command is encountered.
      *
-     * @param object object to delete (this object comes from the first sequence)
+     * @param object object to delete (this object comes from the first sequence).
      */
     void visitDeleteCommand(T object);
 
     /**
      * Method called when an insert command is encountered.
      *
-     * @param object object to insert (this object comes from the second sequence)
+     * @param object object to insert (this object comes from the second sequence).
      */
     void visitInsertCommand(T object);
 
     /**
      * Method called when a keep command is encountered.
      *
-     * @param object object to keep (this object comes from the first sequence)
+     * @param object object to keep (this object comes from the first sequence).
      */
     void visitKeepCommand(T object);
 

src/main/java/org/apache/commons/text/diff/DeleteCommand.java

@@ -36,7 +36,7 @@ public class DeleteCommand<T> extends EditCommand<T> {
     /**
      * Constructs a new instance of {@link DeleteCommand}.
      *
-     * @param object  the object of the first sequence that should be deleted
+     * @param object  the object of the first sequence that should be deleted.
      */
     public DeleteCommand(final T object) {
         super(object);
@@ -46,7 +46,7 @@ public DeleteCommand(final T object) {
      * Accepts a visitor. When a {@code DeleteCommand} accepts a visitor, it calls
      * its {@link CommandVisitor#visitDeleteCommand visitDeleteCommand} method.
      *
-     * @param visitor  the visitor to be accepted
+     * @param visitor  the visitor to be accepted.
      */
     @Override
     public void accept(final CommandVisitor<T> visitor) {

src/main/java/org/apache/commons/text/diff/EditCommand.java

@@ -58,8 +58,7 @@ public abstract class EditCommand<T> {
     /**
      * Constructs a new instance of EditCommand.
      *
-     * @param object  reference to the object associated with this command, this
-     *   refers to an element of one of the sequences being compared
+     * @param object reference to the object associated with this command, this refers to an element of one of the sequences being compared.
      */
     protected EditCommand(final T object) {
         this.object = object;
@@ -68,18 +67,17 @@ protected EditCommand(final T object) {
     /**
      * Accepts a visitor.
      * <p>
-     * This method is invoked for each commands belonging to
-     * an {@link EditScript EditScript}, in order to implement the visitor design pattern
+     * This method is invoked for each commands belonging to an {@link EditScript EditScript}, in order to implement the visitor design pattern
      * </p>
      *
-     * @param visitor  the visitor to be accepted
+     * @param visitor the visitor to be accepted.
      */
     public abstract void accept(CommandVisitor<T> visitor);
 
     /**
      * Gets the object associated with this command.
      *
-     * @return The object on which the command is applied
+     * @return The object on which the command is applied.
      */
     protected T getObject() {
         return object;

src/main/java/org/apache/commons/text/diff/EditScript.java

@@ -67,7 +67,7 @@ public EditScript() {
     /**
      * Appends a delete command to the script.
      *
-     * @param command  command to add
+     * @param command  command to add.
      */
     public void append(final DeleteCommand<T> command) {
         commands.add(command);
@@ -77,7 +77,7 @@ public void append(final DeleteCommand<T> command) {
     /**
      * Appends an insert command to the script.
      *
-     * @param command  command to add
+     * @param command  command to add.
      */
     public void append(final InsertCommand<T> command) {
         commands.add(command);
@@ -87,7 +87,7 @@ public void append(final InsertCommand<T> command) {
     /**
      * Appends a keep command to the script.
      *
-     * @param command  command to add
+     * @param command  command to add.
      */
     public void append(final KeepCommand<T> command) {
         commands.add(command);
@@ -99,7 +99,7 @@ public void append(final KeepCommand<T> command) {
      * longest common subsequence is the number of {@link KeepCommand keep
      * commands} in the script.
      *
-     * @return length of the Longest Common Subsequence
+     * @return length of the Longest Common Subsequence.
      */
     public int getLCSLength() {
         return lcsLength;
@@ -110,7 +110,7 @@ public int getLCSLength() {
      * modification is the number of {@link DeleteCommand delete} and
      * {@link InsertCommand insert} commands in the script.
      *
-     * @return number of effective modifications
+     * @return number of effective modifications.
      */
     public int getModifications() {
         return modifications;
@@ -123,7 +123,7 @@ public int getModifications() {
      * commands in order and call the appropriate method as each command is
      * encountered.
      *
-     * @param visitor  the visitor that will visit all commands in turn
+     * @param visitor  the visitor that will visit all commands in turn.
      */
     public void visit(final CommandVisitor<T> visitor) {
         commands.forEach(command -> command.accept(visitor));

src/main/java/org/apache/commons/text/diff/InsertCommand.java

@@ -36,7 +36,7 @@ public class InsertCommand<T> extends EditCommand<T> {
     /**
      * Constructs a new instance of InsertCommand.
      *
-     * @param object  the object of the second sequence that should be inserted
+     * @param object  the object of the second sequence that should be inserted.
      */
     public InsertCommand(final T object) {
         super(object);
@@ -47,7 +47,7 @@ public InsertCommand(final T object) {
      * it calls its {@link CommandVisitor#visitInsertCommand visitInsertCommand}
      * method.
      *
-     * @param visitor  the visitor to be accepted
+     * @param visitor  the visitor to be accepted.
      */
     @Override
     public void accept(final CommandVisitor<T> visitor) {

src/main/java/org/apache/commons/text/diff/KeepCommand.java

@@ -36,19 +36,17 @@ public class KeepCommand<T> extends EditCommand<T> {
     /**
      * Constructs a new instance of KeepCommand.
      *
-     * @param object  the object belonging to both sequences (the object is a
-     *   reference to the instance in the first sequence which is known
-     *   to be equal to an instance in the second sequence)
+     * @param object the object belonging to both sequences (the object is a reference to the instance in the first sequence which is known to be equal to an
+     *               instance in the second sequence)
      */
     public KeepCommand(final T object) {
         super(object);
     }
 
     /**
-     * Accepts a visitor. When a {@code KeepCommand} accepts a visitor, it
-     * calls its {@link CommandVisitor#visitKeepCommand visitKeepCommand} method.
+     * Accepts a visitor. When a {@code KeepCommand} accepts a visitor, it calls its {@link CommandVisitor#visitKeepCommand visitKeepCommand} method.
      *
-     * @param visitor  the visitor to be accepted
+     * @param visitor the visitor to be accepted.
      */
     @Override
     public void accept(final CommandVisitor<T> visitor) {

src/main/java/org/apache/commons/text/diff/ReplacementsFinder.java

@@ -72,19 +72,19 @@ public class ReplacementsFinder<T> implements CommandVisitor<T> {
     /**
      * Constructs a new instance of {@link ReplacementsFinder}.
      *
-     * @param handler  handler to call when synchronized sequences are found
+     * @param handler handler to call when synchronized sequences are found
      */
     public ReplacementsFinder(final ReplacementsHandler<T> handler) {
         pendingInsertions = new ArrayList<>();
-        pendingDeletions  = new ArrayList<>();
-        skipped           = 0;
-        this.handler      = handler;
+        pendingDeletions = new ArrayList<>();
+        skipped = 0;
+        this.handler = handler;
     }
 
     /**
      * Add an object to the pending deletions set.
      *
-     * @param object  object to delete
+     * @param object object to delete.
      */
     @Override
     public void visitDeleteCommand(final T object) {
@@ -94,7 +94,7 @@ public void visitDeleteCommand(final T object) {
     /**
      * Add an object to the pending insertions set.
      *
-     * @param object  object to insert
+     * @param object object to insert.
      */
     @Override
     public void visitInsertCommand(final T object) {
@@ -104,11 +104,10 @@ public void visitInsertCommand(final T object) {
     /**
      * Handle a synchronization object.
      * <p>
-     * When a synchronization object is identified, the pending insertions and
-     * pending deletions sets are provided to the user handler as subsequences.
+     * When a synchronization object is identified, the pending insertions and pending deletions sets are provided to the user handler as subsequences.
      * </p>
      *
-     * @param object  synchronization object detected
+     * @param object synchronization object detected.
      */
     @Override
     public void visitKeepCommand(final T object) {

src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.apache.commons.text.diff;
 
 import java.util.List;
@@ -30,25 +31,18 @@ public interface ReplacementsHandler<T> {
     /**
      * Handle two synchronized sequences.
      * <p>
-     * This method is called by a {@link ReplacementsFinder ReplacementsFinder}
-     * instance when it has synchronized two sub-sequences of object arrays
-     * being compared, and at least one of the sequences is non-empty. Since the
-     * sequences are synchronized, the objects before the two sub-sequences are
-     * equals (if they exist). This property also holds for the objects after
-     * the two sub-sequences.
+     * This method is called by a {@link ReplacementsFinder ReplacementsFinder} instance when it has synchronized two sub-sequences of object arrays being
+     * compared, and at least one of the sequences is non-empty. Since the sequences are synchronized, the objects before the two sub-sequences are equals (if
+     * they exist). This property also holds for the objects after the two sub-sequences.
      * </p>
      * <p>
-     * The replacement is defined as replacing the {@code from}
-     * sub-sequence into the {@code to} sub-sequence.
+     * The replacement is defined as replacing the {@code from} sub-sequence into the {@code to} sub-sequence.
      * </p>
      *
-     * @param skipped  number of tokens skipped since the last call (i.e. number of
-     *   tokens that were in both sequences), this number should be strictly positive
-     *   except on the very first call where it can be zero (if the first object of
-     *   the two sequences are different)
-     * @param from  sub-sequence of objects coming from the first sequence
-     * @param to  sub-sequence of objects coming from the second sequence
+     * @param skipped number of tokens skipped since the last call (i.e. number of tokens that were in both sequences), this number should be strictly positive
+     *                except on the very first call where it can be zero (if the first object of the two sequences are different).
+     * @param from    sub-sequence of objects coming from the first sequence.
+     * @param to      sub-sequence of objects coming from the second sequence.
      */
     void handleReplacement(int skipped, List<T> from, List<T> to);
-
 }