org.jenkinsci.plugins.blockbuildfinalproject

Class BlockBuildJobProperty.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<hudson.model.JobProperty<?>>

hudson.model.JobPropertyDescriptor

org.jenkinsci.plugins.blockbuildfinalproject.BlockBuildJobProperty.DescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable

Enclosing class:

BlockBuildJobProperty

@Extension
public static final class BlockBuildJobProperty.DescriptorImpl
extends hudson.model.JobPropertyDescriptor

Provides autocompletion and validation for the project textbox fields.

Author:

Chad Rosenquist

Nested Class Summary

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

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.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
hudson.model.AutoCompletionCandidates	doAutoCompleteFinalDownstreamProjects(String value) Auto completes the list of final downstream projects.
hudson.model.AutoCompletionCandidates	doAutoCompleteFinalUpstreamProjects(String value) Auto completes the list of final upstream projects.
hudson.util.FormValidation	doCheckFinalDownstreamProjects(String value, hudson.model.AbstractProject<?,?> context) Checks the projects the end-user entered into a textbox are valid.
hudson.util.FormValidation	doCheckFinalUpstreamProjects(String value, hudson.model.AbstractProject<?,?> context) Checks the projects the end-user entered into a textbox are valid.
hudson.util.FormValidation	doCheckUseBlockBuildDownstreamProject(String value, hudson.model.AbstractProject<?,?> context) Validates useBlockBuildDownstreamProject check box.
hudson.util.FormValidation	doCheckUseBlockBuildUpstreamProject(String value, hudson.model.AbstractProject<?,?> context) Validates useBlockBuildUpstreamProject check box.
String	getDisplayName()
boolean	isApplicable(Class<? extends hudson.model.Job> jobType) Returns always true as it can be used in all types of jobs.

Methods inherited from class hudson.model.JobPropertyDescriptor

all, getPropertyDescriptors, newInstance

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, 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()

Specified by:

getDisplayName in class hudson.model.Descriptor<hudson.model.JobProperty<?>>

isApplicable

public boolean isApplicable(Class<? extends hudson.model.Job> jobType)

Returns always true as it can be used in all types of jobs.

Overrides:

isApplicable in class hudson.model.JobPropertyDescriptor

Parameters:

jobType - the job type to be checked if this property is applicable.

Returns:

true

doCheckUseBlockBuildUpstreamProject

public hudson.util.FormValidation doCheckUseBlockBuildUpstreamProject(@QueryParameter
                                                                      String value,
                                                                      @AncestorInPath
                                                                      hudson.model.AbstractProject<?,?> context)

Validates useBlockBuildUpstreamProject check box.

Parameters:

value - useBlockBuildUpstreamProject check box

context - The current project

Returns:

warning - If 'Block build when upstream project is building (Advanced Project Options)' is checked. This plugin could interfere with this Jenkins builtin option. ok - If the Advanced Project Options is not checked. In order for blockBuildWhenUpstreamBuilding() to work, the project must first be saved. If the user checks the Advanced Project Options box and then checks useBlockBuildUpstreamProject, without saving, a warning message will NOT be logged.

doCheckUseBlockBuildDownstreamProject

public hudson.util.FormValidation doCheckUseBlockBuildDownstreamProject(@QueryParameter
                                                                        String value,
                                                                        @AncestorInPath
                                                                        hudson.model.AbstractProject<?,?> context)

Validates useBlockBuildDownstreamProject check box.

Parameters:

value - useBlockBuildDownstreamProject check box

context - The current project

Returns:

warning - If 'Block build when downstream project is building (Advanced Project Options)' is checked. This plugin could interfere with this Jenkins builtin option. ok - If the Advanced Project Options is not checked. In order for blockBuildWhenDownstreamBuilding() to work, the project must first be saved. If the user checks the Advanced Project Options box and then checks useBlockBuildDownstreamProject, without saving, a warning message will NOT be logged.

doAutoCompleteFinalUpstreamProjects

public hudson.model.AutoCompletionCandidates doAutoCompleteFinalUpstreamProjects(@QueryParameter
                                                                                 String value)

Auto completes the list of final upstream projects.

Parameters:

value - the text the end-user typed into the textbox

Returns:

list of projects that start with value

doAutoCompleteFinalDownstreamProjects

public hudson.model.AutoCompletionCandidates doAutoCompleteFinalDownstreamProjects(@QueryParameter
                                                                                   String value)

Auto completes the list of final downstream projects.

Parameters:

value - the text the end-user typed into the textbox

Returns:

list of projects that start with value

doCheckFinalUpstreamProjects

public hudson.util.FormValidation doCheckFinalUpstreamProjects(@QueryParameter
                                                               String value,
                                                               @AncestorInPath
                                                               hudson.model.AbstractProject<?,?> context)

Checks the projects the end-user entered into a textbox are valid.

Parameters:

value - list of projects the end-user entered

context - current project

Returns:

ok - if all the projects are valid error - if any of the projects are invalid or not buildable

doCheckFinalDownstreamProjects

public hudson.util.FormValidation doCheckFinalDownstreamProjects(@QueryParameter
                                                                 String value,
                                                                 @AncestorInPath
                                                                 hudson.model.AbstractProject<?,?> context)

Checks the projects the end-user entered into a textbox are valid.

Parameters:

value - list of projects the end-user entered

context - current project

Returns:

ok - if all the projects are valid error - if any of the projects are invalid or not buildable