org.jenkinsci.plugins.edithelp

Class EditHelpRootAction

java.lang.Object

org.jenkinsci.plugins.edithelp.EditHelpRootAction

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Action, hudson.model.ModelObject, hudson.model.RootAction

@Extension
public class EditHelpRootAction
extends Object
implements hudson.model.RootAction

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
EditHelpRootAction()

Method Summary

Methods

Modifier and Type	Method and Description
org.kohsuke.stapler.HttpResponse	doHelpInfo(String className)
void	doUpdateHelpInfo(String className, String updatedClassText)
String	getDisplayName()
String	getIconFileName()
String	getUrlName()

Methods inherited from class java.lang.Object

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

Constructor Detail

EditHelpRootAction

public EditHelpRootAction()
                   throws IOException,
                          FileNotFoundException

Throws:

IOException

FileNotFoundException

Method Detail

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.Action

Specified by:

getDisplayName in interface hudson.model.ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action

doHelpInfo

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public org.kohsuke.stapler.HttpResponse doHelpInfo(@QueryParameter(value="class")
                                                                                                        String className)

doUpdateHelpInfo

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doUpdateHelpInfo(@QueryParameter(value="class")
                                                                                  String className,
                                                                                  @QueryParameter(value="textArea")
                                                                                  String updatedClassText)