net.nicoulaj.maven.plugins.checksum.execution

Class AbstractExecution

java.lang.Object

net.nicoulaj.maven.plugins.checksum.execution.AbstractExecution

All Implemented Interfaces:

Execution

Direct Known Subclasses:

FailOnErrorExecution, NeverFailExecution

public abstract class AbstractExecution
extends Object
implements Execution

Base class for Execution implementations.

Since:

1.0

Author:

Julien Nicoulaud

See Also:

Execution

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	algorithms The list of algorithms used for execution.
protected boolean	failIfNoAlgorithms Fail if no files no process.
protected boolean	failIfNoFiles Fail if no files no process.
protected boolean	failIfNoTargets Fail if no files no process.
protected List<ChecksumFile>	files The list of files used for the execution.
protected String	subPath Part of relative path to exclude from file path
protected List<ExecutionTarget>	targets The list of targets used for the execution.

Constructor Summary

Constructors

Constructor and Description
AbstractExecution()

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 Execution.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	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.nicoulaj.maven.plugins.checksum.execution.Execution

run

Field Detail

files

protected List<ChecksumFile> files

The list of files used for the execution.

subPath

protected String subPath

Part of relative path to exclude from file path

algorithms

protected List<String> algorithms

The list of algorithms used for execution.

targets

protected List<ExecutionTarget> targets

The list of targets used for the execution.

failIfNoFiles

protected boolean failIfNoFiles

Fail if no files no process.

failIfNoAlgorithms

protected boolean failIfNoAlgorithms

Fail if no files no process.

failIfNoTargets

protected boolean failIfNoTargets

Fail if no files no process.

Constructor Detail

AbstractExecution

public AbstractExecution()

Method Detail

getFiles

public List<ChecksumFile> getFiles()

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

Specified by:

getFiles in interface Execution

Returns:

the files configured for this execution.

setFiles

public void setFiles(List<ChecksumFile> files)

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

Specified by:

setFiles in interface Execution

Parameters:

files - the value to set.

getSubPath

public String getSubPath()

Get the part of relative path that will be removed.

Specified by:

getSubPath in interface Execution

Returns:

the part of relative path that will be removed.

setSubPath

public void setSubPath(String subPath)

Set the part of relative path that will be removed.

Specified by:

setSubPath in interface Execution

Parameters:

subPath - of relative path that will be removed.

addFile

public void addFile(ChecksumFile file)

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

Specified by:

addFile in interface Execution

Parameters:

file - the file to add.

removeFile

public void removeFile(ChecksumFile file)

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

Specified by:

removeFile in interface Execution

Parameters:

file - the file to remove.

getAlgorithms

public List<String> getAlgorithms()

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

Specified by:

getAlgorithms in interface Execution

Returns:

the algorithms configured for this execution.

setAlgorithms

public void setAlgorithms(List<String> algorithms)

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

Specified by:

setAlgorithms in interface Execution

Parameters:

algorithms - the value to set.

addAlgorithm

public void addAlgorithm(String algorithm)

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

Specified by:

addAlgorithm in interface Execution

Parameters:

algorithm - the algorithm to add.

removeAlgorithm

public void removeAlgorithm(String algorithm)

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

Specified by:

removeAlgorithm in interface Execution

Parameters:

algorithm - the algorithm to remove.

getTargets

public List<ExecutionTarget> getTargets()

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

Specified by:

getTargets in interface Execution

Returns:

the targets configured for this execution.

addTarget

public void addTarget(ExecutionTarget target)

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

Specified by:

addTarget in interface Execution

Parameters:

target - the target to add.

removeTarget

public void removeTarget(ExecutionTarget target)

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

Specified by:

removeTarget in interface Execution

Parameters:

target - the target to remove.

setTargets

public void setTargets(List<ExecutionTarget> targets)

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

Specified by:

setTargets in interface Execution

Parameters:

targets - the value to set.

isFailIfNoFiles

public boolean isFailIfNoFiles()

Execution should fail if no file has been added.

Specified by:

isFailIfNoFiles in interface Execution

Returns:

true if execution should fail if no file has been added

setFailIfNoFiles

public void setFailIfNoFiles(boolean failIfNoFiles)

Execution should fail if no file has been added.

Specified by:

setFailIfNoFiles in interface Execution

Parameters:

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

isFailIfNoAlgorithms

public boolean isFailIfNoAlgorithms()

Execution should fail if no algorithm has been added.

Specified by:

isFailIfNoAlgorithms in interface Execution

Returns:

true if execution should fail if no algorithm has been added

setFailIfNoAlgorithms

public void setFailIfNoAlgorithms(boolean failIfNoAlgorithms)

Execution should fail if no algorithm has been added.

Specified by:

setFailIfNoAlgorithms in interface Execution

Parameters:

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

isFailIfNoTargets

public boolean isFailIfNoTargets()

Execution should fail if no target has been added.

Specified by:

isFailIfNoTargets in interface Execution

Returns:

true if execution should fail if no target has been added

setFailIfNoTargets

public void setFailIfNoTargets(boolean failIfNoTargets)

Execution should fail if no target has been added.

Specified by:

setFailIfNoTargets in interface Execution

Parameters:

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

checkParameters

public void checkParameters()
                     throws ExecutionException

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

Specified by:

checkParameters in interface Execution

Throws:

ExecutionException - if some parameters are not initialized or invalid.