jp.ikedam.jenkins.plugins.jobcopy_builder

Class AdditionalFileset

java.lang.Object

hudson.model.AbstractDescribableImpl<AdditionalFileset>

jp.ikedam.jenkins.plugins.jobcopy_builder.AdditionalFileset

All Implemented Interfaces:

Describable<AdditionalFileset>, Serializable

public class AdditionalFileset
extends AbstractDescribableImpl<AdditionalFileset>
implements Serializable

A set of files to copy additional to JOBNAME/config.xml.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdditionalFileset.DescriptorImpl The internal class to work with views.

Constructor Summary

Constructors

Constructor and Description
AdditionalFileset(String includeFile, String excludeFile, boolean overwrite, List<JobcopyOperation> jobcopyOperationList) Constructor to instantiate from parameters in the job configuration page.

Method Summary

Modifier and Type	Method and Description
String	getExcludeFile() Returns the pattern of file not to copy.
protected List<String>	getFilesToCopy(File dir)
String	getIncludeFile() Returns the pattern of file to copy.
List<JobcopyOperation>	getJobcopyOperationList() Returns the list of operations.
boolean	isOverwrite() Returns whether to overwrite an existing job.
boolean	perform(TopLevelItem toJob, TopLevelItem fromJob, EnvVars env, PrintStream logger) Copy the additional files and apply additional operations.
protected boolean	performToFile(File dstFile, File srcFile, EnvVars env, PrintStream logger) Process one file.

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

AdditionalFileset

@DataBoundConstructor
public AdditionalFileset(String includeFile,
                                               String excludeFile,
                                               boolean overwrite,
                                               List<JobcopyOperation> jobcopyOperationList)

Constructor to instantiate from parameters in the job configuration page. When instantiating from the saved configuration, the object is directly serialized with XStream, and no constructor is used.

Parameters:

includeFile - a pattern of files to copy.

excludeFile - a pattern of files not to copy.

overwrite - whether to overwrite if the file if it is already existing.

jobcopyOperationList - the list of operations to be performed when copying.

Method Detail

getIncludeFile

public String getIncludeFile()

Returns the pattern of file to copy.

Returns:

the includeFile

getExcludeFile

public String getExcludeFile()

Returns the pattern of file not to copy.

Returns:

the excludeFile

isOverwrite

public boolean isOverwrite()

Returns whether to overwrite an existing job. If the copied-to file is already exists, jobcopy build step works as following depending on this value.

How AdditionalFileset works with isOverwrite

isOverwrite	behavior
true	Overwrite the file.
false	Not overwrite the file.

Returns:

whether to overwrite an existing file.

getJobcopyOperationList

public List<JobcopyOperation> getJobcopyOperationList()

Returns the list of operations.

Returns:

the list of operations

perform

public boolean perform(TopLevelItem toJob,
                       TopLevelItem fromJob,
                       EnvVars env,
                       PrintStream logger)

Copy the additional files and apply additional operations.

Parameters:

toJob - job to copy to

fromJob - job to copy from

env - environment variables

logger - console

Returns:

whether the work succeeded.

getFilesToCopy

protected List<String> getFilesToCopy(File dir)

performToFile

protected boolean performToFile(File dstFile,
                                File srcFile,
                                EnvVars env,
                                PrintStream logger)

Process one file.

Parameters:

dstFile - file to copy to

srcFile - file to copy from

env - environment variables

logger - console

Returns:

true if succeeded to process and copy.