Package org.jenkinsci.plugins.pipeline.utility.steps

Class AbstractFileDecompressStep

java.lang.Object
hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
org.jenkinsci.plugins.workflow.steps.Step
org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileStep
org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileDecompressStep
All Implemented Interfaces:
ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>
Direct Known Subclasses:
UnTarStep, UnZipStep
public abstract class AbstractFileDecompressStep extends AbstractFileStep

  • Constructor Details

    • AbstractFileDecompressStep

      public AbstractFileDecompressStep()

  • Method Details

    • getDir

      public String getDir()
      The relative path of the base directory to create the archive from. Leave empty to create from the current working directory.
      Returns:
      the dir

    • setDir

      @DataBoundSetter public void setDir(String dir)
      The relative path of the base directory to create the archive from. Leave empty to create from the current working directory.
      Parameters:
      dir - the dir

    • getGlob

      public String getGlob()
      Ant style pattern of files to extract from the archive. Leave empty to include all files and directories.
      Returns:
      the include pattern

    • setGlob

      @DataBoundSetter public void setGlob(String glob)
      Ant style pattern of files to extract from the archive. Leave empty to include all files and directories.
      Parameters:
      glob - the include pattern

    • isTest

      public boolean isTest()
      Test the integrity of the archive instead of extracting it. When this parameter is enabled, all other parameters (except for AbstractFileStep.getFile()) will be ignored. The step will return true or false depending on the result instead of throwing an exception.
      Returns:
      if the archive should just be tested or not

    • setTest

      @DataBoundSetter public void setTest(boolean test)
      Test the integrity of the archive instead of extracting it. When this parameter is enabled, all other parameters (except for AbstractFileStep.getFile()) will be ignored. The step will return true or false depending on the result instead of throwing an exception.
      Parameters:
      test - if the archive should just be tested or not

    • isQuiet

      public boolean isQuiet()
      Suppress the verbose output that logs every single file that is dealt with.
      Returns:
      if verbose logging should be suppressed

    • setQuiet

      @DataBoundSetter public void setQuiet(boolean quiet)
      Suppress the verbose output that logs every single file that is dealt with.
      Parameters:
      quiet - if verbose logging should be suppressed