com.github.difflib.algorithm.DiffAlgorithmI Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of diffutils Show documentation

The DiffUtils library for computing diffs, applying patches, generationg side-by-side view in Java.

The newest version!

/*
 * Copyright 2018 java-diff-utils.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.github.difflib.algorithm;

import java.util.Arrays;
import java.util.List;

/**
 * Interface of a diff algorithm.
 *
 * @author Tobias Warneke ([email protected])
 */
public interface DiffAlgorithmI {

    /**
     * Computes the changeset to patch the source list to the target list.
     *
     * @param source source data
     * @param target target data
     * @param progress progress listener
     * @return
     * @throws DiffException
     */
    List computeDiff(List source, List target, DiffAlgorithmListener progress) throws DiffException;

    /**
     * Simple extension to compute a changeset using arrays.
     *
     * @param source
     * @param target
     * @param progress
     * @return
     * @throws com.github.difflib.algorithm.DiffException
     */
    default List computeDiff(T[] source, T[] target, DiffAlgorithmListener progress) throws DiffException {
        return computeDiff(Arrays.asList(source), Arrays.asList(target), progress);
    }
}