hudson.plugins.tasks.util
Class PluginDescriptor

java.lang.Object
  hudson.model.Descriptor<T>
      hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>
          hudson.plugins.tasks.util.PluginDescriptor

All Implemented Interfaces:

hudson.model.Saveable

Direct Known Subclasses:

TasksDescriptor

public abstract class PluginDescriptor
extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

Base class for a Hudson plug/in descriptor.

Author:

Ulli Hafner

Nested Class Summary

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

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

PluginDescriptor(java.lang.Class<? extends hudson.tasks.Publisher> clazz)
Creates a new instance of PluginDescriptor.

Method Summary

void	doCheckDefaultEncoding(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) Performs on-the-fly validation on the default encoding.
hudson.util.FormValidation	doCheckHeight(java.lang.String height) Performs on-the-fly validation on the trend graph height.
void	doCheckPattern(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) Performs on-the-fly validation on the file mask.
void	doCheckThreshold(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) Performs on-the-fly validation on the annotations threshold.
java.lang.String	getHelpFile()
abstract java.lang.String	getIconUrl() Returns the URL of the plug-in icon (24x24 image).
abstract java.lang.String	getPluginName() Returns the name of the plug-in.
java.lang.String	getPluginResultUrlName() Returns the name of the plug-in.
java.lang.String	getPluginRoot() Returns the root folder of this plug-in.
boolean	isApplicable(java.lang.Class<? extends hudson.model.AbstractProject> jobType)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

configure, configure, configure, convert, doHelp, find, find, getCheckUrl, getConfigPage, getDisplayName, getGlobalConfigPage, getHelpFile, getJsonSafeClassName, getPropertyType, getViewPage, isInstance, load, newInstance, newInstance, newInstancesFromHeteroList, save, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginDescriptor

public PluginDescriptor(java.lang.Class<? extends hudson.tasks.Publisher> clazz)

Creates a new instance of PluginDescriptor.

Parameters:

clazz - the type of the publisher

Method Detail

getHelpFile

public final java.lang.String getHelpFile()

Overrides:

getHelpFile in class hudson.model.Descriptor<hudson.tasks.Publisher>

getPluginRoot

public java.lang.String getPluginRoot()

Returns the root folder of this plug-in.

Returns:

the name of the root folder of this plug-in

getPluginResultUrlName

public final java.lang.String getPluginResultUrlName()

Returns the name of the plug-in.

Returns:

the name of the plug-in

getPluginName

public abstract java.lang.String getPluginName()

Returns the name of the plug-in.

Returns:

the name of the plug-in

getIconUrl

public abstract java.lang.String getIconUrl()

Returns the URL of the plug-in icon (24x24 image).

Returns:

the URL of the plug-in icon

doCheckDefaultEncoding

public final void doCheckDefaultEncoding(org.kohsuke.stapler.StaplerRequest request,
                                         org.kohsuke.stapler.StaplerResponse response)
                                  throws java.io.IOException,
                                         javax.servlet.ServletException

Performs on-the-fly validation on the default encoding.

Parameters:

request - Stapler request

response - Stapler response

Throws:

java.io.IOException

javax.servlet.ServletException

doCheckPattern

public final void doCheckPattern(org.kohsuke.stapler.StaplerRequest request,
                                 org.kohsuke.stapler.StaplerResponse response)
                          throws java.io.IOException,
                                 javax.servlet.ServletException

Performs on-the-fly validation on the file mask.

Parameters:

request - Stapler request

response - Stapler response

Throws:

java.io.IOException

javax.servlet.ServletException

doCheckThreshold

public final void doCheckThreshold(org.kohsuke.stapler.StaplerRequest request,
                                   org.kohsuke.stapler.StaplerResponse response)
                            throws java.io.IOException,
                                   javax.servlet.ServletException

Performs on-the-fly validation on the annotations threshold.

Parameters:

request - Stapler request

response - Stapler response

Throws:

java.io.IOException

javax.servlet.ServletException

doCheckHeight

public hudson.util.FormValidation doCheckHeight(@QueryParameter
                                                java.lang.String height)

Performs on-the-fly validation on the trend graph height.

Parameters:

height - the height

Returns:

the form validation

isApplicable

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

Specified by:

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