io.github.ghokun.updated.scm.SourceCodeChangeDetector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of updated-maven-plugin Show documentation

A maven plugin that lists and validates updated modules compared to remote repositories

The newest version!

/*
 * MIT License
 *
 * Copyright (c) 2020 ghokun
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package io.github.ghokun.updated.scm;

import java.util.Set;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;

/**
 * Source Code Change detection interface. Any implementation of this interface should create {@link SourceCodeChanges}
 * tree with {@link DiffType} and module information.
 *
 * @author ghokun
 * @since 1.0.0
 */
@FunctionalInterface
public interface SourceCodeChangeDetector {
	
	/**
	 * Detect source code changes that is made locally.
	 *
	 * @param project Top level MavenProject to detect changes.
	 * @param projects All modules including root.
	 * @param log Maven plugin logger.
	 * @param remoteBranch Remote branch name to compare local changes.
	 * @throws MojoExecutionException Throws exception
	 * @return SourceCodeChanges tree with project information.
	 */
	SourceCodeChanges detectChanges(
			MavenProject project,
			Set projects,
			Log log,
			String remoteBranch) throws MojoExecutionException;
}