Package org.jenkinsci.plugins.workflow.cps

Class SnippetizerLink.OnlineDocsLink

java.lang.Object

org.jenkinsci.plugins.workflow.cps.SnippetizerLink

org.jenkinsci.plugins.workflow.cps.SnippetizerLink.OnlineDocsLink

All Implemented Interfaces:

ExtensionPoint

Enclosing class:

SnippetizerLink

@Extension(ordinal=700.0)
public static class SnippetizerLink.OnlineDocsLink
extends SnippetizerLink

Nested Class Summary

Nested classes/interfaces inherited from class org.jenkinsci.plugins.workflow.cps.SnippetizerLink

SnippetizerLink.ExamplesLink, SnippetizerLink.GDSLLink, SnippetizerLink.GeneratorLink, SnippetizerLink.GlobalsReferenceLink, SnippetizerLink.OnlineDocsLink, SnippetizerLink.StepReferenceLink

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
OnlineDocsLink()

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Get the display name for the link.
String	getUrl()	Get the URL this link should point to, which will be used by SnippetizerLink.getDisplayUrl().
boolean	inNewWindow()	Check whether the link should target a new window - this defaults to false;

Methods inherited from class org.jenkinsci.plugins.workflow.cps.SnippetizerLink

getDisplayUrl, getIcon

Methods inherited from class java.lang.Object

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

Constructor Details

OnlineDocsLink

public OnlineDocsLink()

Method Details

getUrl

@NonNull
public String getUrl()

Description copied from class: SnippetizerLink

Get the URL this link should point to, which will be used by SnippetizerLink.getDisplayUrl(). If this is not absolute, SnippetizerLink.getDisplayUrl() will link to this within the current context.

Specified by:

getUrl in class SnippetizerLink

getDisplayName

@NonNull
public String getDisplayName()

Description copied from class: SnippetizerLink

Get the display name for the link.

Specified by:

getDisplayName in class SnippetizerLink

inNewWindow

public boolean inNewWindow()

Description copied from class: SnippetizerLink

Check whether the link should target a new window - this defaults to false;

Overrides:

inNewWindow in class SnippetizerLink