Constructors Constructor Description
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description
getDisplayName()Deprecated.Gets the string to be displayed.
getIconFileName()Deprecated.Gets the name of the icon.
getUrlName()Deprecated.Gets the URL path name.
restoreTo(AbstractBuild<?,?> owner, FilePath dst, TaskListener listener)Deprecated.Restores the snapshot to the given file system location.
public abstract void restoreTo(AbstractBuild<?,?> owner, FilePath dst, TaskListener listener) throws IOException, InterruptedExceptionDeprecated.Restores the snapshot to the given file system location.
owner- The build that owns this action. It's always the same value for any given
WorkspaceSnapshot, but passed in separately so that implementations don't need to keep them in fields.
dst- The file path to which the snapshot shall be restored to.
listener- Send the progress of the restoration to this listener. Never null.
public String getIconFileName()Deprecated.Gets the name of the icon.
- Specified by:
- If the icon name is prefixed with "symbol-", a Jenkins Symbol
will be used.
If just a file name (like "abc.gif") is returned, it will be interpreted as a file name inside
/images/24x24. This is useful for using one of the stock images.
If an absolute file name that starts from '/' is returned (like "/plugin/foo/abc.gif"), then it will be interpreted as a path from the context root of Jenkins. This is useful to pick up image files from a plugin.
Finally, return null to hide it from the task list. This is normally not very useful, but this can be used for actions that only contribute
floatBox.jellyand no task list item. The other case where this is useful is to avoid showing links that require a privilege when the user is anonymous.
- See Also:
- Jenkins Symbols,
public String getDisplayName()Deprecated.Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".
public String getUrlName()Deprecated.Gets the URL path name.
For example, if this method returns "xyz", and if the parent object (that this action is associated with) is bound to /foo/bar/zot, then this action object will be exposed to /foo/bar/zot/xyz.
This method should return a string that's unique among other
The returned string can be an absolute URL, like "http://www.sun.com/", which is useful for directly connecting to external systems.
If the returned string starts with '/', like '/foo', then it's assumed to be relative to the context path of the Jenkins webapp.