jenkins.scm.impl

Class NullSCMSource

java.lang.Object

hudson.model.AbstractDescribableImpl<SCMSource>

jenkins.scm.api.SCMSource

jenkins.scm.impl.NullSCMSource

All Implemented Interfaces:

ExtensionPoint, Describable<SCMSource>

public class NullSCMSource
extends SCMSource

A special SCMSource that does not fetch any SCMHead instances and will build instances of NullSCM.

Author:

Stephen Connolly

Nested Class Summary

Nested classes/interfaces inherited from class jenkins.scm.api.SCMSource

SCMSource.SourceByItem

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID The "magic" id of the NullSCMSource.

Fields inherited from class jenkins.scm.api.SCMSource

PRONOUN

Constructor Summary

Constructors

Constructor and Description
NullSCMSource() Constructor.

Method Summary

Modifier and Type	Method and Description
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(SCMSourceCriteria criteria, SCMHeadObserver observer, SCMHeadEvent<?> event, TaskListener listener) SPI: Fetches the latest heads and corresponding revisions that are originating from the supplied event.

Methods inherited from class jenkins.scm.api.SCMSource

afterSave, build, canProbe, checkInterrupt, createProbe, defaultListener, equals, fetch, fetch, fetch, fetch, fetch, fetch, fetch, fetchActions, fetchActions, fetchActions, fetchRevisions, fromSCMFileSystem, getCategories, getCriteria, getDescriptor, getId, getOwner, getPronoun, getTraits, getTrustedRevision, hashCode, hasId, isCategoryEnabled, newProbe, parentHeads, parentRevisions, retrieve, retrieve, retrieve, retrieve, retrieve, retrieve, retrieveActions, retrieveActions, retrieveActions, retrieveRevisions, setId, setOwner, setTraits, toString, withId

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

The "magic" id of the NullSCMSource.

Constructor Detail

NullSCMSource

public NullSCMSource()

Constructor.

Method Detail

retrieve

protected void retrieve(@CheckForNull
                        SCMSourceCriteria criteria,
                        @NonNull
                        SCMHeadObserver observer,
                        @CheckForNull
                        SCMHeadEvent<?> event,
                        @NonNull
                        TaskListener listener)
                 throws IOException,
                        InterruptedException

SPI: Fetches the latest heads and corresponding revisions that are originating from the supplied event. If the supplied event is one that the implementer trusts, then the implementer may be able to optimize retrieval to minimize round trips. Implementers are free to cache intermediary results but the call must always check the validity of any intermediary caches.

It is vitally important that implementations must periodically call SCMSource.checkInterrupt() otherwise it will be impossible for users to interrupt the operation.

The default implementation wraps the SCMHeadObserver using SCMHeadEvent.filter(SCMSource, SCMHeadObserver) and delegates to SCMSource.retrieve(SCMSourceCriteria, SCMHeadObserver, TaskListener)

Specified by:

retrieve in class SCMSource

Parameters:

criteria - the criteria to use, if non-null them implementations mustfilter all SCMHead instances against the SCMSourceCriteria.isHead(SCMSourceCriteria.Probe, TaskListener) before passing through to the SCMHeadObserver.

observer - an observer of interim results, if the event is non-null then the observer will already have been filtered with SCMHeadEvent.filter(SCMSource, SCMHeadObserver).

event - the (optional) event from which the operation should be scoped.

listener - the task listener.

Throws:

IOException - if an error occurs while performing the operation.

InterruptedException - if any thread has interrupted the current thread.

build

@NonNull
public 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.