Package fr.ens.biologie.genomique.eoulsan.requirements

Class AbstractRequirement

java.lang.Object

fr.ens.biologie.genomique.eoulsan.requirements.AbstractRequirement

All Implemented Interfaces:

Requirement

Direct Known Subclasses:

DockerRequirement, PathRequirement, RserveRequirement

public abstract class AbstractRequirement
extends Object
implements Requirement

This class define an abstract requirement.

Since:

2.0

Author:

Laurent Jourdren

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	INSTALLABLE_PARAMETER
static String	NAME_PARAMETER
protected static String	OPTIONAL_PARAMETER

Constructor Summary

Constructors

Constructor	Description
AbstractRequirement()

Method Summary

Modifier and Type	Method	Description
void	configure(Set<Parameter> parameters)	Configure the requirement.
Set<Parameter>	getParameters()	Get the parameters of the requirement
boolean	isInstallable()	Test if the requirement is installable.
boolean	isOptional()	Test if the requirement is optional.
protected void	setInstallable(boolean installable)
protected void	setOptionnal(boolean optional)

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.ens.biologie.genomique.eoulsan.requirements.Requirement

getName, install, isAvailable

Field Detail

NAME_PARAMETER

public static final String NAME_PARAMETER

See Also:

Constant Field Values

OPTIONAL_PARAMETER

protected static final String OPTIONAL_PARAMETER

See Also:

Constant Field Values

INSTALLABLE_PARAMETER

protected static final String INSTALLABLE_PARAMETER

See Also:

Constant Field Values

Constructor Detail

AbstractRequirement

public AbstractRequirement()

Method Detail

isOptional

public boolean isOptional()

Description copied from interface: Requirement

Test if the requirement is optional.

Specified by:

isOptional in interface Requirement

Returns:

true if he requirement is optional

isInstallable

public boolean isInstallable()

Description copied from interface: Requirement

Test if the requirement is installable.

Specified by:

isInstallable in interface Requirement

Returns:

true if the requirement is installable

setOptionnal

protected void setOptionnal(boolean optional)

setInstallable

protected void setInstallable(boolean installable)

getParameters

public Set<Parameter> getParameters()

Description copied from interface: Requirement

Get the parameters of the requirement

Specified by:

getParameters in interface Requirement

Returns:

a set of parameters

configure

public void configure(Set<Parameter> parameters)
               throws EoulsanException

Description copied from interface: Requirement

Configure the requirement.

Specified by:

configure in interface Requirement

Parameters:

parameters - the parameters of the requirement

Throws:

EoulsanException - if an error occurs while configuring the requirement