hudson.fsp

Class WorkspaceSnapshotSCM

java.lang.Object

hudson.scm.SCM

hudson.fsp.WorkspaceSnapshotSCM

All Implemented Interfaces:

ExtensionPoint, Describable<SCM>

public class WorkspaceSnapshotSCM
extends SCM

SCM that inherits the workspace from another build through WorkspaceSnapshot

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
String	jobName The job name from which we inherit the workspace.
String	permalink The permalink name indicating the build from which to inherit the workspace.

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor and Description
WorkspaceSnapshotSCM(String jobName, String permalink)

Method Summary

Modifier and Type	Method and Description
SCMRevisionState	calcRevisionsFromBuild(AbstractBuild<?,?> build, Launcher launcher, TaskListener listener)
boolean	checkout(AbstractBuild build, Launcher launcher, FilePath workspace, BuildListener listener, File changelogFile)
protected PollingResult	compareRemoteRevisionWith(AbstractProject project, Launcher launcher, FilePath workspace, TaskListener listener, SCMRevisionState baseline)
ChangeLogParser	createChangeLogParser() The returned object will be used to parse changelog.xml.
SCMDescriptor<?>	getDescriptor() Gets the descriptor for this instance.
hudson.fsp.WorkspaceSnapshotSCM.Snapshot	resolve() Obtains the WorkspaceSnapshot object that this SCM points to, or throws WorkspaceSnapshotSCM.ResolvedFailedException upon failing.

Methods inherited from class hudson.scm.SCM

_calcRevisionsFromBuild, _for, _for, all, buildEnvVars, calcRevisionsFromBuild, checkout, compareRemoteRevisionWith, createEmptyChangeLog, createEmptyChangeLog, getApi, getBrowser, getEffectiveBrowser, getKey, getModuleRoot, getModuleRoot, getModuleRoots, getModuleRoots, getType, guessBrowser, nullify, poll, pollChanges, postCheckout, postCheckout, processWorkspaceBeforeDeletion, processWorkspaceBeforeDeletion, requiresWorkspaceForPolling, supportsPolling

Methods inherited from class java.lang.Object

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

Field Detail

jobName

public String jobName

The job name from which we inherit the workspace.

permalink

public String permalink

The permalink name indicating the build from which to inherit the workspace.

Constructor Detail

WorkspaceSnapshotSCM

@DataBoundConstructor
public WorkspaceSnapshotSCM(String jobName,
                                                  String permalink)

Method Detail

resolve

public hudson.fsp.WorkspaceSnapshotSCM.Snapshot resolve()
                                                 throws hudson.fsp.WorkspaceSnapshotSCM.ResolvedFailedException

Obtains the WorkspaceSnapshot object that this SCM points to, or throws WorkspaceSnapshotSCM.ResolvedFailedException upon failing.

Returns:

never null.

Throws:

hudson.fsp.WorkspaceSnapshotSCM.ResolvedFailedException

calcRevisionsFromBuild

public SCMRevisionState calcRevisionsFromBuild(AbstractBuild<?,?> build,
                                               Launcher launcher,
                                               TaskListener listener)
                                        throws IOException,
                                               InterruptedException

Overrides:

calcRevisionsFromBuild in class SCM

Throws:

IOException

InterruptedException

compareRemoteRevisionWith

protected PollingResult compareRemoteRevisionWith(AbstractProject project,
                                                  Launcher launcher,
                                                  FilePath workspace,
                                                  TaskListener listener,
                                                  SCMRevisionState baseline)
                                           throws IOException,
                                                  InterruptedException

Overrides:

compareRemoteRevisionWith in class SCM

Throws:

IOException

InterruptedException

checkout

public boolean checkout(AbstractBuild build,
                        Launcher launcher,
                        FilePath workspace,
                        BuildListener listener,
                        File changelogFile)
                 throws IOException,
                        InterruptedException

Overrides:

checkout in class SCM

Throws:

IOException

InterruptedException

createChangeLogParser

public ChangeLogParser createChangeLogParser()

Description copied from class: SCM

The returned object will be used to parse changelog.xml.

Specified by:

createChangeLogParser in class SCM

getDescriptor

public SCMDescriptor<?> getDescriptor()

Description copied from interface: Describable

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

Specified by:

getDescriptor in interface Describable<SCM>

Overrides:

getDescriptor in class SCM