public abstract class SCMRevisionState extends Object implements Action
This object is used so that the successive polling can compare the tip of the repository now vs what it was when it was last polled. (Before 1.345, Hudson was only able to compare the tip of the repository vs the state of the workspace, which resulted in a problem like HUDSON-2180.
SCMRevisionState
is persisted as an action to AbstractBuild
.
Modifier and Type | Field and Description |
---|---|
static SCMRevisionState |
NONE |
Constructor and Description |
---|
SCMRevisionState() |
Modifier and Type | Method and Description |
---|---|
String |
getDisplayName()
Gets the string to be displayed.
|
String |
getIconFileName()
Gets the file name of the icon.
|
String |
getUrlName()
Gets the URL path name.
|
public static SCMRevisionState NONE
public String getIconFileName()
Action
getIconFileName
in interface Action
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.
Functions.isAnonymous()
,
Functions.getIconFilePath(Action)
public String getDisplayName()
Action
getDisplayName
in interface Action
getDisplayName
in interface ModelObject
public String getUrlName()
Action
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 Action
s.
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.
getUrlName
in interface Action
Action.getIconFileName()
.Functions.getActionUrl(String, Action)
Copyright © 2004–2018. All rights reserved.