Package hudson.plugins.sectioned_view

Class SectionedViewSectionDescriptor

java.lang.Object

hudson.model.Descriptor<SectionedViewSection>

hudson.plugins.sectioned_view.SectionedViewSectionDescriptor

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Direct Known Subclasses:

FolderViewSection.DescriptorImpl, JobGraphsSection.DescriptorImpl, ListViewSection.DescriptorImpl, TestResultViewSection.DescriptorImpl, TextSection.DescriptorImpl, ViewListingSection.DescriptorImpl

public abstract class SectionedViewSectionDescriptor
extends Descriptor<SectionedViewSection>

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

Modifier	Constructor	Description
protected	SectionedViewSectionDescriptor()
protected	SectionedViewSectionDescriptor(Class<? extends SectionedViewSection> clazz)

Method Summary

Modifier and Type	Method	Description
FormValidation	doCheckIncludeRegex(String value)	Checks if the include regular expression is valid.
static String	escapeJobName(String name)	Utility method which escapes job names so that they can be safely inserted into the name field of HTML inputs.
boolean	hasJobFilterExtensions()
SectionedViewSection	newInstance(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject formData)

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, 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 Details

SectionedViewSectionDescriptor

protected SectionedViewSectionDescriptor(Class<? extends SectionedViewSection> clazz)

SectionedViewSectionDescriptor

protected SectionedViewSectionDescriptor()

Method Details

hasJobFilterExtensions

public boolean hasJobFilterExtensions()

newInstance

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

Overrides:

newInstance in class Descriptor<SectionedViewSection>

Throws:

Descriptor.FormException

doCheckIncludeRegex

public FormValidation doCheckIncludeRegex(@QueryParameter
 String value)
                                   throws IOException,
jakarta.servlet.ServletException,
InterruptedException

Checks if the include regular expression is valid.

Throws:

IOException

jakarta.servlet.ServletException

InterruptedException

escapeJobName

public static String escapeJobName(String name)

Utility method which escapes job names so that they can be safely inserted into the name field of HTML inputs. Escaping is needed since job names may contain characters which have special meaning in name fields of HTML inputs. For example the dot (.) character, in a name field Jenkins input handling (Stapler) will treat the dot as an hierarchical separation and split the name on the dot, which in this case is unwanted. So in order to mitigate that dots are replaces with a character which are disallowed in job names and have no special meaning in input fields, e.g. hash tag (#).

Parameters:

name - Job name to be escaped before insertion into HTML input name

Returns:

Escaped job name