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

Class AbstractFileCompressStep

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

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>

Direct Known Subclasses:

TarStep, ZipStep

public abstract class AbstractFileCompressStep
extends AbstractFileStep

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
AbstractFileCompressStep()

Method Summary

Modifier and Type	Method	Description
String	getDir()	The relative path of the base directory to create the archive from.
String	getExclude()	Ant style pattern of files to exclude from the archive.
String	getGlob()	Ant style pattern of files to include in the archive.
boolean	isArchive()	If the archive file should be archived as an artifact of the current build.
boolean	isDefaultExcludes()	The defaultExcludes of ant java pattern.
boolean	isOverwrite()	If the archive file should be overwritten in case of already existing a file with the same name.
void	setArchive(boolean archive)	If the archive file should be archived as an artifact of the current build.
void	setDefaultExcludes(boolean defaultExcludes)	The defaultExcludes of ant java pattern.
void	setDir(String dir)	The relative path of the base directory to create the archive from.
void	setExclude(String exclude)	Ant style pattern of files to exclude in the archive.
void	setGlob(String glob)	Ant style pattern of files to include in the archive.
void	setOverwrite(boolean overwrite)	If the archive file should be overwritten in case of already existing a file with the same name.

Methods inherited from class org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileStep

getFile, setFile

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor, start

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFileCompressStep

public AbstractFileCompressStep()

Method Detail

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 include in 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 include in the archive. Leave empty to include all files and directories.

Parameters:

glob - the include pattern

getExclude

public String getExclude()

Ant style pattern of files to exclude from the archive.

Returns:

the exclude pattern

setExclude

@DataBoundSetter
public void setExclude(String exclude)

Ant style pattern of files to exclude in the archive.

Parameters:

exclude - the exclude pattern

isArchive

public boolean isArchive()

If the archive file should be archived as an artifact of the current build. The file will still be kept in the workspace after archiving.

Returns:

if it should be archived or not

setArchive

@DataBoundSetter
public void setArchive(boolean archive)

If the archive file should be archived as an artifact of the current build. The file will still be kept in the workspace after archiving.

Parameters:

archive - if it should be archived or not

isOverwrite

public boolean isOverwrite()

If the archive file should be overwritten in case of already existing a file with the same name.

Returns:

if the file should be overwritten or not in case of existing.

setOverwrite

@DataBoundSetter
public void setOverwrite(boolean overwrite)

If the archive file should be overwritten in case of already existing a file with the same name.

Parameters:

overwrite - if the file should be overwritten or not in case of existing.

isDefaultExcludes

public boolean isDefaultExcludes()

The defaultExcludes of ant java pattern.

Returns:

the defaultExcludes boolean value

setDefaultExcludes

@DataBoundSetter
public void setDefaultExcludes(boolean defaultExcludes)

The defaultExcludes of ant java pattern.

Parameters:

defaultExcludes - the defaultExcludes boolean value