Package hudson.console

Class ConsoleAnnotationDescriptor

java.lang.Object

hudson.model.Descriptor<ConsoleNote<?>>

hudson.console.ConsoleAnnotationDescriptor

All Implemented Interfaces:

ExtensionPoint, Saveable, Loadable, OnMaster

Direct Known Subclasses:

ExpandableDetailsNote.DescriptorImpl, HyperlinkNote.DescriptorImpl, Maven3MojoNote.DescriptorImpl, MavenErrorNote.DescriptorImpl, MavenMojoNote.DescriptorImpl, MavenWarningNote.DescriptorImpl

public abstract class ConsoleAnnotationDescriptor
extends Descriptor<ConsoleNote<?>>
implements ExtensionPoint

Descriptor for ConsoleNote.

Since:

1.349

Author:

Kohsuke Kawaguchi

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

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	ConsoleAnnotationDescriptor()
protected	ConsoleAnnotationDescriptor(Class<? extends ConsoleNote<?>> clazz)

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<ConsoleNote<?>,ConsoleAnnotationDescriptor>	all()	Returns all the registered ConsoleAnnotationDescriptor descriptors.
void	doScriptJs(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
void	doStyleCss(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
String	getDisplayName()	Human readable name of this kind of configurable object.
boolean	hasScript()	Returns true if this descriptor has a JavaScript to be inserted on applicable console page.
boolean	hasStylesheet()	Returns true if this descriptor has a stylesheet to be inserted on applicable console page.

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, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, 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

ConsoleAnnotationDescriptor

protected ConsoleAnnotationDescriptor(Class<? extends ConsoleNote<?>> clazz)

ConsoleAnnotationDescriptor

protected ConsoleAnnotationDescriptor()

Method Details

getDisplayName

@NonNull
public String getDisplayName()

Human readable name of this kind of configurable object. Should be overridden for most descriptors, if the display name is visible somehow. As a fallback it uses Class.getSimpleName() on Descriptor.clazz, so for example MyThing from some.pkg.MyThing.DescriptorImpl. Historically some implementations returned null as a way of hiding the descriptor from the UI, but this is generally managed by an explicit method such as isEnabled or isApplicable. Users use this name to enable/disable annotations.

Overrides:

getDisplayName in class Descriptor<ConsoleNote<?>>

hasScript

public boolean hasScript()

Returns true if this descriptor has a JavaScript to be inserted on applicable console page.

hasStylesheet

public boolean hasStylesheet()

Returns true if this descriptor has a stylesheet to be inserted on applicable console page.

doScriptJs

@WebMethod(name="script.js")
public void doScriptJs(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

doStyleCss

@WebMethod(name="style.css")
public void doStyleCss(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

all

public static DescriptorExtensionList<ConsoleNote<?>,ConsoleAnnotationDescriptor> all()

Returns all the registered ConsoleAnnotationDescriptor descriptors.