net.nicoulaj.maven.plugins.checksum.execution

Interface Execution

All Known Implementing Classes:

AbstractExecution, FailOnErrorExecution, NeverFailExecution

public interface Execution

Effective execution of plugin goals used Mojo implementations.

Since:

1.0

Author:

Julien Nicoulaud

See Also:

net.nicoulaj.maven.plugins.checksum.mojo

Method Summary

Modifier and Type	Method and Description
void	addAlgorithm(String algorithm) Add an algorithm to the list of checksum algorithms to be used by the execution.
void	addFile(ChecksumFile file) Add a file to the list of files to be processed by the execution.
void	addTarget(ExecutionTarget target) Add a target to the list of ExecutionTarget to be used by the execution.
void	checkParameters() Check that an execution can be run with the run() method.
List<String>	getAlgorithms() Get the list of checksum algorithms to be used by the execution.
List<ChecksumFile>	getFiles() Get the list of files to be processed by the execution.
String	getSubPath() Get the part of relative path that will be removed.
List<ExecutionTarget>	getTargets() Get the list of ExecutionTarget to be used by the execution.
boolean	isFailIfNoAlgorithms() Execution should fail if no algorithm has been added.
boolean	isFailIfNoFiles() Execution should fail if no file has been added.
boolean	isFailIfNoTargets() Execution should fail if no target has been added.
void	removeAlgorithm(String algorithm) Remove an algorithm from the list of checksum algorithms to be used by the execution.
void	removeFile(ChecksumFile file) Remove a file from the list of files to be processed by the execution.
void	removeTarget(ExecutionTarget target) Remove a target from the list of ExecutionTarget to be used by the execution.
void	run() Run the execution using for the files, algorithms and targets set.
void	setAlgorithms(List<String> algorithms) Set the list of checksum algorithms to be used by the execution.
void	setFailIfNoAlgorithms(boolean failIfNoAlgorithms) Execution should fail if no algorithm has been added.
void	setFailIfNoFiles(boolean failIfNoFiles) Execution should fail if no file has been added.
void	setFailIfNoTargets(boolean failIfNoTargets) Execution should fail if no target has been added.
void	setFiles(List<ChecksumFile> files) Set the list of files to be processed by the execution.
void	setSubPath(String subPath) Set the part of relative path that will be removed.
void	setTargets(List<ExecutionTarget> targets) Set the list of ExecutionTarget to be used by the execution.

Method Detail

getFiles

List<ChecksumFile> getFiles()

Get the list of files to be processed by the execution.

Returns:

the files configured for this execution.

setFiles

void setFiles(List<ChecksumFile> files)

Set the list of files to be processed by the execution.

Parameters:

files - the value to set.

getSubPath

String getSubPath()

Get the part of relative path that will be removed.

Returns:

the part of relative path that will be removed.

Since:

1.3

setSubPath

void setSubPath(String subPath)

Set the part of relative path that will be removed.

Parameters:

subPath - of relative path that will be removed.

Since:

1.3

addFile

void addFile(ChecksumFile file)

Add a file to the list of files to be processed by the execution.

Parameters:

file - the file to add.

removeFile

void removeFile(ChecksumFile file)

Remove a file from the list of files to be processed by the execution.

Parameters:

file - the file to remove.

getAlgorithms

List<String> getAlgorithms()

Get the list of checksum algorithms to be used by the execution.

Returns:

the algorithms configured for this execution.

setAlgorithms

void setAlgorithms(List<String> algorithms)

Set the list of checksum algorithms to be used by the execution.

Parameters:

algorithms - the value to set.

addAlgorithm

void addAlgorithm(String algorithm)

Add an algorithm to the list of checksum algorithms to be used by the execution.

Parameters:

algorithm - the algorithm to add.

removeAlgorithm

void removeAlgorithm(String algorithm)

Remove an algorithm from the list of checksum algorithms to be used by the execution.

Parameters:

algorithm - the algorithm to remove.

getTargets

List<ExecutionTarget> getTargets()

Get the list of ExecutionTarget to be used by the execution.

Returns:

the targets configured for this execution.

setTargets

void setTargets(List<ExecutionTarget> targets)

Set the list of ExecutionTarget to be used by the execution.

Parameters:

targets - the value to set.

addTarget

void addTarget(ExecutionTarget target)

Add a target to the list of ExecutionTarget to be used by the execution.

Parameters:

target - the target to add.

removeTarget

void removeTarget(ExecutionTarget target)

Remove a target from the list of ExecutionTarget to be used by the execution.

Parameters:

target - the target to remove.

isFailIfNoFiles

boolean isFailIfNoFiles()

Execution should fail if no file has been added.

Returns:

true if execution should fail if no file has been added

setFailIfNoFiles

void setFailIfNoFiles(boolean failIfNoFiles)

Execution should fail if no file has been added.

Parameters:

failIfNoFiles - true if execution should fail if no file has been added

isFailIfNoAlgorithms

boolean isFailIfNoAlgorithms()

Execution should fail if no algorithm has been added.

Returns:

true if execution should fail if no algorithm has been added

setFailIfNoAlgorithms

void setFailIfNoAlgorithms(boolean failIfNoAlgorithms)

Execution should fail if no algorithm has been added.

Parameters:

failIfNoAlgorithms - true if execution should fail if no algorithm has been added

isFailIfNoTargets

boolean isFailIfNoTargets()

Execution should fail if no target has been added.

Returns:

true if execution should fail if no target has been added

setFailIfNoTargets

void setFailIfNoTargets(boolean failIfNoTargets)

Execution should fail if no target has been added.

Parameters:

failIfNoTargets - true if execution should fail if no target has been added

checkParameters

void checkParameters()
              throws ExecutionException

Check that an execution can be run with the run() method.

Throws:

ExecutionException - if some parameters are not initialized or invalid.

run

void run()
  throws ExecutionException

Run the execution using for the files, algorithms and targets set.

Throws:

ExecutionException - if an error happens while running the execution.