jenkins.plugins.clangscanbuild

Class ClangScanBuildDescriptor

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<hudson.tasks.Builder>

jenkins.plugins.clangscanbuild.ClangScanBuildDescriptor

All Implemented Interfaces:

hudson.model.Saveable

public class ClangScanBuildDescriptor
extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Builder>

This class is the BuildStepDescriptor for the Clang Scan-Build build step. Jenkins will call the doCheck* methods below to validate the user entered values on the job configuration screen. Each of the doCheck* methods corresponds to a field defined in the config.jelly file in the resources directory. Jenkins uses the field names to reflectively locate doCheck*, doFill*Items methods.

Author:

Joshua Kennedy

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
ClangScanBuildDescriptor()

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData) This method is invoked when the user finally clicks 'Save' on the 'Configure System' global configuration screen.
hudson.util.FormValidation	doCheckConfig(String value)
hudson.util.FormValidation	doCheckTarget(String value)
hudson.util.FormValidation	doCheckTargetSdk(String value)
String	getDisplayName()
ClangScanBuildToolInstallation[]	getInstallations()
ClangScanBuildToolInstallation	getNamedInstallation(String name)
ClangScanBuildToolInstallation.ClangStaticAnalyzerToolDescriptor	getToolDescriptor()
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> jobType)
void	setInstallations(ClangScanBuildToolInstallation[] clangInstallations)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, 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, 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

ClangScanBuildDescriptor

public ClangScanBuildDescriptor()

Method Detail

getToolDescriptor

public ClangScanBuildToolInstallation.ClangStaticAnalyzerToolDescriptor getToolDescriptor()

getInstallations

public ClangScanBuildToolInstallation[] getInstallations()

getNamedInstallation

public ClangScanBuildToolInstallation getNamedInstallation(String name)

setInstallations

public void setInstallations(ClangScanBuildToolInstallation[] clangInstallations)

doCheckTarget

public hudson.util.FormValidation doCheckTarget(@QueryParameter
                                                String value)
                                         throws IOException,
                                                javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

doCheckTargetSdk

public hudson.util.FormValidation doCheckTargetSdk(@QueryParameter
                                                   String value)
                                            throws IOException,
                                                   javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

doCheckConfig

public hudson.util.FormValidation doCheckConfig(@QueryParameter
                                                String value)
                                         throws IOException,
                                                javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in class hudson.model.Descriptor<hudson.tasks.Builder>

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject formData)
                  throws hudson.model.Descriptor.FormException

This method is invoked when the user finally clicks 'Save' on the 'Configure System' global configuration screen. This method should move data from the JSONObject which is populated with the submitted form data for the Clang Scan-Build Plugin from the 'Configure System' screen. The options for this plugin are rendered using the global.jelly file from the resources directory. Each field in the global.jelly file will be mapped to the JSONObject by field name. This method should move each value for each field from the JSONObject into private fields with getters/setters in this class. Once all the fields are marshalled to an instance of this class, this method should invoke 'save()' to persist the data for the user.

Overrides:

configure in class hudson.model.Descriptor<hudson.tasks.Builder>

Throws:

hudson.model.Descriptor.FormException

isApplicable

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

Specified by:

isApplicable in class hudson.tasks.BuildStepDescriptor<hudson.tasks.Builder>