Package hudson.scm

Class SCMRevisionState

java.lang.Object

hudson.scm.SCMRevisionState

All Implemented Interfaces:

Action, ModelObject

public abstract class SCMRevisionState
extends Object
implements Action

Immutable object that represents revisions of the files in the repository, used to represent the result of a SCM polling.

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 JENKINS-2180.

SCMRevisionState is persisted as an action to AbstractBuild.

Since:

1.345

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
static SCMRevisionState	NONE

Constructor Summary

Constructors

Constructor	Description
SCMRevisionState()

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Gets the string to be displayed.
String	getIconFileName()	Gets the name of the icon.
String	getUrlName()	Gets the URL path name.

Methods inherited from class java.lang.Object

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

Field Details

NONE

public static SCMRevisionState NONE

Constructor Details

SCMRevisionState

public SCMRevisionState()

Method Details

getIconFileName

public String getIconFileName()

Description copied from interface: Action

Gets the name of the icon.

Specified by:

getIconFileName in interface Action

Returns:

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.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.

See Also:

• Jenkins Symbols
• Functions.isAnonymous()
• Functions.getIconFilePath(Action)

getDisplayName

public String getDisplayName()

Description copied from interface: Action

Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

Returns:

Can be null in case the action is hidden.

getUrlName

public String getUrlName()

Description copied from interface: Action

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 Actions.

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.

Specified by:

getUrlName in interface Action

Returns:

null if this action object doesn't need to be bound to web (when you do that, be sure to also return null from Action.getIconFileName().

See Also:

• Functions.getActionUrl(String, Action)