jp.ikedam.jenkins.plugins.jobcopy_builder

Class JobcopyBuilder.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<Builder>

jp.ikedam.jenkins.plugins.jobcopy_builder.JobcopyBuilder.DescriptorImpl

All Implemented Interfaces:

Saveable, OnMaster

Enclosing class:

JobcopyBuilder

@Extension
public static final class JobcopyBuilder.DescriptorImpl
extends BuildStepDescriptor<Builder>

The internal class to work with views. The following files are used (put in main/resource directory in the source tree).

config.jelly

shown as a part of a job configuration page.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
DescriptorImpl()

Method Summary

Modifier and Type	Method and Description
FormValidation	doCheckFromJobName(AbstractProject<?,?> project, String fromJobName) Validate "From Job Name" field.
FormValidation	doCheckJobName(AbstractProject<?,?> project, String jobName, boolean warnIfExists, boolean warnIfNotExists) Validate "From Job Name" or "To Job Name" field.
FormValidation	doCheckToJobName(AbstractProject<?,?> project, String toJobName, boolean overwrite) Validate "To Job Name" field.
ComboBoxModel	doFillFromJobNameItems(AbstractProject<?,?> project) Returns the list of jobs.
String	getDisplayName() Returns the display name Displayed in the "Add build step" dropdown in a job configuration page.
DescriptorExtensionList<JobcopyOperation,Descriptor<JobcopyOperation>>	getJobcopyOperationDescriptors() Returns all the available JobcopyOperation.
boolean	isApplicable(Class<? extends AbstractProject> jobType) Test whether this build step can be applied to the specified job type.

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

DescriptorImpl

public DescriptorImpl()

Method Detail

getDisplayName

public String getDisplayName()

Returns the display name Displayed in the "Add build step" dropdown in a job configuration page.

Overrides:

getDisplayName in class Descriptor<Builder>

Returns:

the display name

See Also:

Descriptor.getDisplayName()

isApplicable

public boolean isApplicable(Class<? extends AbstractProject> jobType)

Test whether this build step can be applied to the specified job type. This build step works for any type of jobs, for always returns true.

Specified by:

isApplicable in class BuildStepDescriptor<Builder>

Parameters:

jobType - the type of the job to be tested.

Returns:

true

See Also:

BuildStepDescriptor.isApplicable(java.lang.Class)

getJobcopyOperationDescriptors

public DescriptorExtensionList<JobcopyOperation,Descriptor<JobcopyOperation>> getJobcopyOperationDescriptors()

Returns all the available JobcopyOperation. Used for the contents of "Add Copy Operation" dropdown.

Returns:

the list of JobcopyOperation

doFillFromJobNameItems

public ComboBoxModel doFillFromJobNameItems(@AncestorInPath
                                            AbstractProject<?,?> project)

Returns the list of jobs. Used for the autocomplete of From Job Name.

Parameters:

project - the current job

Returns:

the list of names of jobs

doCheckJobName

public FormValidation doCheckJobName(AbstractProject<?,?> project,
                                     String jobName,
                                     boolean warnIfExists,
                                     boolean warnIfNotExists)

Validate "From Job Name" or "To Job Name" field. Returns as following:

Return values for parameter combinations

jobName	warnIfExists	warnIfNotExists	Returns
Blank	any	any	error
value containing variables	any	any	ok
existing job	false	any	ok
existing job	true	any	warning
non existing job	any	false	ok
non existing job	any	true	warning

Parameters:

project - the current job

jobName - the name of the job to check

warnIfExists - returns warning if the job exists

warnIfNotExists - returns warning if the job not exists

Returns:

validation result

doCheckFromJobName

public FormValidation doCheckFromJobName(@AncestorInPath
                                         AbstractProject<?,?> project,
                                         @QueryParameter
                                         String fromJobName)

Validate "From Job Name" field.

Parameters:

project - the current job

fromJobName - the input to "From Job Name"

Returns:

validation result

doCheckToJobName

public FormValidation doCheckToJobName(@AncestorInPath
                                       AbstractProject<?,?> project,
                                       @QueryParameter
                                       String toJobName,
                                       @QueryParameter
                                       boolean overwrite)

Validate "To Job Name" field.

Parameters:

project - the current job

toJobName - the input to "To Job Name"

overwrite - the input to "Overwrite"

Returns:

validation result