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

Class DockerRequirement

java.lang.Object

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

fr.ens.biologie.genomique.eoulsan.requirements.DockerRequirement

All Implemented Interfaces:

Requirement

public class DockerRequirement
extends AbstractRequirement

This class define a Docker requirement.

Since:

2.0

Author:

Laurent Jourdren

Field Summary

Fields

Modifier and Type	Field	Description
static String	REQUIREMENT_NAME

Fields inherited from class fr.ens.biologie.genomique.eoulsan.requirements.AbstractRequirement

INSTALLABLE_PARAMETER, NAME_PARAMETER, OPTIONAL_PARAMETER

Constructor Summary

Constructors

Constructor	Description
DockerRequirement()

Method Summary

Modifier and Type	Method	Description
void	configure(Set<Parameter> parameters)	Configure the requirement.
String	getName()	The name of the requirement.
Set<Parameter>	getParameters()	Get the parameters of the requirement
void	install(Progress progress)	Install the requirement.
boolean	isAvailable()	Test if the requirement is available.
static Requirement	newDockerRequirement(String dockerImage)	Create a new docker image as mandatory requirement.
static Requirement	newDockerRequirement(String dockerImage, boolean optional)	Create a new docker image requirement.
String	toString()

Methods inherited from class fr.ens.biologie.genomique.eoulsan.requirements.AbstractRequirement

isInstallable, isOptional, setInstallable, setOptionnal

Methods inherited from class java.lang.Object

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

Field Detail

REQUIREMENT_NAME

public static final String REQUIREMENT_NAME

See Also:

Constant Field Values

Constructor Detail

DockerRequirement

public DockerRequirement()

Method Detail

getName

public String getName()

Description copied from interface: Requirement

The name of the requirement.

Returns:

the name of the requirement

getParameters

public Set<Parameter> getParameters()

Description copied from interface: Requirement

Get the parameters of the requirement

Specified by:

getParameters in interface Requirement

Overrides:

getParameters in class AbstractRequirement

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

Overrides:

configure in class AbstractRequirement

Parameters:

parameters - the parameters of the requirement

Throws:

EoulsanException - if an error occurs while configuring the requirement

isAvailable

public boolean isAvailable()

Description copied from interface: Requirement

Test if the requirement is available.

Returns:

true if he requirement is optional

install

public void install(Progress progress)
             throws EoulsanException

Description copied from interface: Requirement

Install the requirement.

Throws:

EoulsanException - if the requirement cannot be installed

newDockerRequirement

public static Requirement newDockerRequirement(String dockerImage)
                                        throws EoulsanException

Create a new docker image as mandatory requirement.

Parameters:

dockerImage - the docker image name.

Throws:

EoulsanException - if an error occurs while configuring the requirement

newDockerRequirement

public static Requirement newDockerRequirement(String dockerImage,
                                               boolean optional)
                                        throws EoulsanException

Create a new docker image requirement.

Parameters:

dockerImage - the docker image

optional - true if the docker image is a mandatory requirement

Throws:

EoulsanException - if an error occurs while configuring the requirement

toString

public String toString()

Overrides:

toString in class Object