SnippetizerLink (Pipeline: Groovy 3894.vd0f0248b_a_fc4 API)

java.lang.Object
- org.jenkinsci.plugins.workflow.cps.SnippetizerLink

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

SnippetizerLink.ExamplesLink, SnippetizerLink.GDSLLink, SnippetizerLink.GeneratorLink, SnippetizerLink.GlobalsReferenceLink, SnippetizerLink.OnlineDocsLink, SnippetizerLink.StepReferenceLink
```
public abstract class SnippetizerLink
extends Object
implements ExtensionPoint
```
A link that will show up on the side panel of the snippet generator and other similar pages. Display order is determined by extension ordinal - highest ordinal first.

Author:

Andrew Bayer

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SnippetizerLink.ExamplesLink`
`static class`	`SnippetizerLink.GDSLLink`
`static class`	`SnippetizerLink.GeneratorLink`
`static class`	`SnippetizerLink.GlobalsReferenceLink`
`static class`	`SnippetizerLink.OnlineDocsLink`
`static class`	`SnippetizerLink.StepReferenceLink`

Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors
Constructor Description

SnippetizerLink()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract String`	`getDisplayName()`	Get the display name for the link.
`String`	`getDisplayUrl()`	Get the actual URL to use in sidepanel.jelly.
`String`	`getIcon()`	Get the icon information for the link.
`abstract String`	`getUrl()`	Get the URL this link should point to, which will be used by `getDisplayUrl()`.
`boolean`	`inNewWindow()`	Check whether the link should target a new window - this defaults to false;

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SnippetizerLink
```
public SnippetizerLink()
```
- Method Detail
  - getUrl
```
@NonNull
public abstract String getUrl()
```
    Get the URL this link should point to, which will be used by getDisplayUrl(). If this is not absolute, getDisplayUrl() will link to this within the current context.
  - getDisplayUrl
```
@NonNull
public final String getDisplayUrl()
```
    Get the actual URL to use in sidepanel.jelly. If getUrl() is not absolute, this will try to get the current Job context and return a url starting with that job's AbstractItem.getUrl() appended with getUrl().
  - getIcon
```
@NonNull
public String getIcon()
```
    Get the icon information for the link.
  - getDisplayName
```
@NonNull
public abstract String getDisplayName()
```
    Get the display name for the link.
  - inNewWindow
```
public boolean inNewWindow()
```
    Check whether the link should target a new window - this defaults to false;