jenkins.scm.api

Class SCMRevisionAction

java.lang.Object

hudson.model.InvisibleAction

jenkins.scm.api.SCMRevisionAction

All Implemented Interfaces:

Action, ModelObject

@ExportedBean
public class SCMRevisionAction
extends InvisibleAction

Action added to AbstractBuild to remember which revision is built in the given build.

Constructor Summary

Constructors

Constructor and Description
SCMRevisionAction(SCMRevision revision) Deprecated. use SCMRevisionAction(SCMSource, SCMRevision)
SCMRevisionAction(SCMSource source, SCMRevision revision) Constructor.

Method Summary

Modifier and Type	Method and Description
SCMRevision	getRevision() Gets the SCMRevision.
static SCMRevision	getRevision(Actionable actionable) Deprecated. use getRevision(SCMSource, Actionable)
static SCMRevision	getRevision(SCMSource source, Actionable actionable) Gets the SCMRevision for the specified SCMSource from the specified Actionable.
String	getSourceId() Gets the SCMSource.getId() that the revision was created for.

Methods inherited from class hudson.model.InvisibleAction

getDisplayName, getIconFileName, getUrlName

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMRevisionAction

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
 @RestrictedSince(value="2.2.0")
 @Deprecated
public SCMRevisionAction(@NonNull
                                                                                                                                         SCMRevision revision)

Deprecated. use SCMRevisionAction(SCMSource, SCMRevision)

Constructor.

Parameters:

revision - the SCMRevision.

SCMRevisionAction

public SCMRevisionAction(@NonNull
                         SCMSource source,
                         @NonNull
                         SCMRevision revision)

Constructor.

Parameters:

source - the SCMSource.

revision - the SCMRevision.

Method Detail

getRevision

@Exported
 @NonNull
public SCMRevision getRevision()

Gets the SCMRevision.

Returns:

the SCMRevision.

getSourceId

@CheckForNull
public String getSourceId()

Gets the SCMSource.getId() that the revision was created for.

Returns:

the SCMSource.getId() that the revision was created for or null when legacy data

Since:

2.2.0

getRevision

@Deprecated
 @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
 @RestrictedSince(value="2.2.0")
 @CheckForNull
public static SCMRevision getRevision(@NonNull
                                                                                                                                                                     Actionable actionable)

Deprecated. use getRevision(SCMSource, Actionable)

Gets the SCMRevision from the specified Actionable.

Parameters:

actionable - Actionable containing a possible SCMRevisionAction.

Returns:

the SCMRevision.

getRevision

@CheckForNull
public static SCMRevision getRevision(@NonNull
                                                    SCMSource source,
                                                    @NonNull
                                                    Actionable actionable)

Gets the SCMRevision for the specified SCMSource from the specified Actionable.

Parameters:

source - the SCMSource to get the revision for.

actionable - Actionable containing a possible SCMRevisionAction.

Returns:

the SCMRevision.