TODO: how to garbage-collect this object, especially for zfs? perhaps when a new build is started?
|Constructor and Description|
|Modifier and Type||Method and Description|
Gets the string to be displayed.
Gets the file name of the icon.
Gets the URL path name.
Restores the snapshot to the given file system location.
public abstract void restoreTo(AbstractBuild<?,?> owner, FilePath dst, TaskListener listener) throws IOException, InterruptedException
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()
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.jelly and 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.
public String getDisplayName()
public String getUrlName()
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.
Copyright © 2004–2017. All rights reserved.