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

Interface Requirement

All Known Implementing Classes:
AbstractRequirement, DockerRequirement, PathRequirement, RserveRequirement
public interface Requirement
This interface define a requirement for an Eoulsan Step.
Since:
2.0
Author:
Laurent Jourdren

  • Method Details

    • getName

      String getName()
      The name of the requirement.
      Returns:
      the name of the requirement

    • isOptional

      boolean isOptional()
      Test if the requirement is optional.
      Returns:
      true if he requirement is optional

    • isAvailable

      boolean isAvailable()
      Test if the requirement is available.
      Returns:
      true if he requirement is optional

    • isInstallable

      boolean isInstallable()
      Test if the requirement is installable.
      Returns:
      true if the requirement is installable

    • getParameters

      Set<Parameter> getParameters()
      Get the parameters of the requirement
      Returns:
      a set of parameters

    • configure

      void configure(Set<Parameter> parameters) throws EoulsanException
      Configure the requirement.
      Parameters:
      parameters - the parameters of the requirement
      Throws:
      EoulsanException - if an error occurs while configuring the requirement

    • install

      void install(Progress progress) throws EoulsanException
      Install the requirement.
      Parameters:
      progress - Progress object
      Throws:
      EoulsanException - if the requirement cannot be installed