net.nicoulaj.maven.plugins.checksum.execution.Execution Maven / Gradle / Ivy

Go to download
/*
 * checksum-maven-plugin - http://checksum-maven-plugin.nicoulaj.net
 * Copyright © 2010-2021 checksum-maven-plugin contributors
 *
 * 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 net.nicoulaj.maven.plugins.checksum.execution;

import net.nicoulaj.maven.plugins.checksum.execution.target.ExecutionTarget;
import net.nicoulaj.maven.plugins.checksum.mojo.ChecksumFile;

import java.util.List;

/**
 * Effective execution of plugin goals used {@link org.apache.maven.plugin.Mojo} implementations.
 *
 * @author Julien Nicoulaud
 * @see net.nicoulaj.maven.plugins.checksum.mojo
 * @since 1.0
 * @version $Id: $Id
 */
public interface Execution
{
    /**
     * Get the list of files to be processed by the execution.
     *
     * @return the files configured for this execution.
     */
    List getFiles();

    /**
     * Set the list of files to be processed by the execution.
     *
     * @param files the value to set.
     */
    void setFiles( List files );

	/**
	 * Get the part of relative path that will be removed.
	 *
	 * @return the part of relative path that will be removed.
	 * @since 1.3
	 */
	String getSubPath();

	/**
	 * Set the part of relative path that will be removed.
	 *
	 * @param subPath of relative path that will be removed.
	 * @since 1.3
	 */
	void setSubPath( String subPath );

    /**
     * Add a file to the list of files to be processed by the execution.
     *
     * @param file the file to add.
     */
    void addFile( ChecksumFile file );

    /**
     * Remove a file from the list of files to be processed by the execution.
     *
     * @param file the file to remove.
     */
    void removeFile( ChecksumFile file );

    /**
     * Get the list of checksum algorithms to be used by the execution.
     *
     * @return the algorithms configured for this execution.
     */
    List getAlgorithms();

    /**
     * Set the list of checksum algorithms to be used by the execution.
     *
     * @param algorithms the value to set.
     */
    void setAlgorithms( List algorithms );

    /**
     * Add an algorithm to the list of checksum algorithms to be used by the execution.
     *
     * @param algorithm the algorithm to add.
     */
    void addAlgorithm( String algorithm );

    /**
     * Remove an algorithm from the list of checksum algorithms to be used by the execution.
     *
     * @param algorithm the algorithm to remove.
     */
    void removeAlgorithm( String algorithm );

    /**
     * Get the list of {@link net.nicoulaj.maven.plugins.checksum.execution.target.ExecutionTarget} to be used by the
     * execution.
     *
     * @return the targets configured for this execution.
     */
    List getTargets();

    /**
     * Set the list of {@link net.nicoulaj.maven.plugins.checksum.execution.target.ExecutionTarget} to be used by the
     * execution.
     *
     * @param targets the value to set.
     */
    void setTargets( List targets );

    /**
     * Add a target to the list of {@link net.nicoulaj.maven.plugins.checksum.execution.target.ExecutionTarget} to be
     * used by the execution.
     *
     * @param target the target to add.
     */
    void addTarget( ExecutionTarget target );

    /**
     * Remove a target from the list of {@link net.nicoulaj.maven.plugins.checksum.execution.target.ExecutionTarget} to
     * be used by the execution.
     *
     * @param target the target to remove.
     */
    void removeTarget( ExecutionTarget target );

    /**
     * Execution should fail if no file has been added.
     *
     * @return {@code true} if execution should fail if no file has been added
     */
    boolean isFailIfNoFiles();

    /**
     * Execution should fail if no file has been added.
     *
     * @param failIfNoFiles {@code true} if execution should fail if no file has been added
     */
    void setFailIfNoFiles(boolean failIfNoFiles);

    /**
     * Execution should fail if no algorithm has been added.
     *
     * @return {@code true} if execution should fail if no algorithm has been added
     */
    boolean isFailIfNoAlgorithms();

    /**
     * Execution should fail if no algorithm has been added.
     *
     * @param failIfNoAlgorithms {@code true} if execution should fail if no algorithm has been added
     */
    void setFailIfNoAlgorithms(boolean failIfNoAlgorithms);

    /**
     * Execution should fail if no target has been added.
     *
     * @return {@code true} if execution should fail if no target has been added
     */
    boolean isFailIfNoTargets();

    /**
     * Execution should fail if no target has been added.
     *
     * @param failIfNoTargets {@code true} if execution should fail if no target has been added
     */
    void setFailIfNoTargets(boolean failIfNoTargets);

    /**
     * Check that an execution can be run with the {@link #run()} method.
     *
     * @throws net.nicoulaj.maven.plugins.checksum.execution.ExecutionException if some parameters are not initialized or invalid.
     */
    void checkParameters()
        throws ExecutionException;

    /**
     * Run the execution using for the files, algorithms and targets set.
     *
     * @throws net.nicoulaj.maven.plugins.checksum.execution.ExecutionException if an error happens while running the execution.
     */
    void run()
        throws ExecutionException;
}