hudson.console
Class ConsoleAnnotationDescriptor

java.lang.Object
  extended by hudson.model.Descriptor<ConsoleNote<?>>
      extended by hudson.console.ConsoleAnnotationDescriptor
All Implemented Interfaces:
ExtensionPoint, Saveable
Direct Known Subclasses:
AntOutcomeNote.DescriptorImpl, AntTargetNote.DescriptorImpl, ExpandableDetailsNote.DescriptorImpl, HudsonExceptionNote.DescriptorImpl, HyperlinkNote.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
 
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
ConsoleAnnotationDescriptor()
           
ConsoleAnnotationDescriptor(Class<? extends ConsoleNote<?>> clazz)
           
 
Method Summary
static DescriptorExtensionList<ConsoleNote<?>,ConsoleAnnotationDescriptor> all()
          Returns all the registered ConsoleAnnotationDescriptor descriptors.
 void doScriptJs(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
           
 void doStyleCss(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
           
abstract  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
calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, getCheckUrl, getConfigFile, getConfigPage, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getPropertyType, getPropertyType, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, toArray, toList, toMap
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConsoleAnnotationDescriptor

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

ConsoleAnnotationDescriptor

public ConsoleAnnotationDescriptor()
Method Detail

getDisplayName

public abstract String getDisplayName()
Human readable name of this kind of configurable object. Users use this name to enable/disable annotations.

Specified by:
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.StaplerRequest req,
                                 org.kohsuke.stapler.StaplerResponse rsp)
                throws IOException,
                       javax.servlet.ServletException
Throws:
IOException
javax.servlet.ServletException

doStyleCss

@WebMethod(name="style.css")
public void doStyleCss(org.kohsuke.stapler.StaplerRequest req,
                                 org.kohsuke.stapler.StaplerResponse rsp)
                throws IOException,
                       javax.servlet.ServletException
Throws:
IOException
javax.servlet.ServletException

all

public static DescriptorExtensionList<ConsoleNote<?>,ConsoleAnnotationDescriptor> all()
Returns all the registered ConsoleAnnotationDescriptor descriptors.



Copyright © 2004-2013 Hudson. All Rights Reserved.