jenkins.scm.impl

Class SingleSCMSource

java.lang.Object

hudson.model.AbstractDescribableImpl<SCMSource>

jenkins.scm.api.SCMSource

jenkins.scm.impl.SingleSCMSource

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<SCMSource>

public class SingleSCMSource
extends SCMSource

A single fixed branch using a legacy SCM implementation.

Author:

Stephen Connolly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SingleSCMSource.DescriptorImpl Our descriptor.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
SingleSCMSource(String id, String name, hudson.scm.SCM scm) Our constructor.

Method Summary

Methods

Modifier and Type	Method and Description
hudson.scm.SCM	build(SCMHead head, SCMRevision revision) Builds a SCM instance for the specified head and revision, no validation of the head is performed, a revision for a different head or source will be treated as equivalent to a null revision.
protected void	retrieve(SCMHeadObserver observer, hudson.model.TaskListener listener) Fetches the latest heads and corresponding revisions.

Methods inherited from class jenkins.scm.api.SCMSource

build, defaultListener, equals, fetch, fetch, fetch, getCriteria, getId, getOwner, hashCode, retrieve, retrieve, setOwner, toString

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SingleSCMSource

@DataBoundConstructor
public SingleSCMSource(String id,
                                    String name,
                                    hudson.scm.SCM scm)

Our constructor.

Parameters:

name - the name of the branch.

scm - the configuration.

Method Detail

retrieve

@NonNull
protected void retrieve(@NonNull
                    SCMHeadObserver observer,
                    @NonNull
                    hudson.model.TaskListener listener)
                 throws IOException

Fetches the latest heads and corresponding revisions. Implementers are free to cache intermediary results but the call must always check the validity of any intermediary caches.

Specified by:

retrieve in class SCMSource

Parameters:

observer - an optional observer of interim results.

listener - the task listener.

Throws:

IOException

build

@NonNull
public hudson.scm.SCM build(@NonNull
                           SCMHead head,
                           @CheckForNull
                           SCMRevision revision)

Builds a SCM instance for the specified head and revision, no validation of the head is performed, a revision for a different head or source will be treated as equivalent to a null revision.

Specified by:

build in class SCMSource

Parameters:

head - the head.

revision - the revision or null.

Returns:

the SCM instance.