Package hudson.plugins.doclinks

Class DocLinksPublisher.DocLinksDescriptor

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<Publisher>

hudson.plugins.doclinks.DocLinksPublisher.DocLinksDescriptor

All Implemented Interfaces:

Saveable, OnMaster

Enclosing class:

DocLinksPublisher

public static class DocLinksPublisher.DocLinksDescriptor
extends BuildStepDescriptor<Publisher>

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	Description
DocLinksDescriptor()

Method Summary

Modifier and Type	Method	Description
FormValidation	doCheckDirectory(AbstractProject<?,?> project, String dir)	check to see if directory is valid and exists.
FormValidation	doCheckFile(AbstractProject<?,?> project, String dir, String file)	check to see if file exists.
FormValidation	doCheckTitle(AbstractProject<?,?> project, String title)	check to see if title is not null.
String	getDisplayName()
boolean	isApplicable(Class<? extends AbstractProject> jobType)
Publisher	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)

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, 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

DocLinksDescriptor

public DocLinksDescriptor()

Method Detail

newInstance

public Publisher newInstance(org.kohsuke.stapler.StaplerRequest req,
                             net.sf.json.JSONObject formData)
                      throws Descriptor.FormException

Overrides:

newInstance in class Descriptor<Publisher>

Throws:

Descriptor.FormException

isApplicable

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

Specified by:

isApplicable in class BuildStepDescriptor<Publisher>

doCheckTitle

public FormValidation doCheckTitle(@AncestorInPath
                                   AbstractProject<?,?> project,
                                   @QueryParameter
                                   String title)
                            throws IOException,
                                   javax.servlet.ServletException

check to see if title is not null.

Throws:

IOException

javax.servlet.ServletException

doCheckDirectory

public FormValidation doCheckDirectory(@AncestorInPath
                                       AbstractProject<?,?> project,
                                       @QueryParameter
                                       String dir)
                                throws IOException,
                                       javax.servlet.ServletException

check to see if directory is valid and exists.

Throws:

IOException

javax.servlet.ServletException

doCheckFile

public FormValidation doCheckFile(@AncestorInPath
                                  AbstractProject<?,?> project,
                                  @QueryParameter
                                  String dir,
                                  @QueryParameter
                                  String file)
                           throws IOException,
                                  javax.servlet.ServletException

check to see if file exists.

Throws:

IOException

javax.servlet.ServletException

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<Publisher>