jenkins.scm.api

Class SCMFileSystem.Builder

java.lang.Object

jenkins.scm.api.SCMFileSystem.Builder

All Implemented Interfaces:

hudson.ExtensionPoint

Enclosing class:

SCMFileSystem

public abstract static class SCMFileSystem.Builder
extends Object
implements hudson.ExtensionPoint

Extension point that allows different plugins to implement SCMFileSystem classes for the same SCM or SCMSource and let Jenkins pick the most capable for any specific SCM implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
SCMFileSystem.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
abstract SCMFileSystem	build(hudson.scm.SCM scm, SCMRevision rev) Given a SCM this should try to build a corresponding SCMFileSystem instance that reflects the content at the specified SCMRevision.
SCMFileSystem	build(SCMSource source, SCMHead head, SCMRevision rev) Given a SCMSource, a SCMHead and a SCMRevision this method should try to build a corresponding SCMFileSystem instance that reflects the content of the specified SCMHead at the specified SCMRevision.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMFileSystem.Builder

public SCMFileSystem.Builder()

Method Detail

build

@CheckForNull
public abstract SCMFileSystem build(@NonNull
                               hudson.scm.SCM scm,
                               @CheckForNull
                               SCMRevision rev)

Given a SCM this should try to build a corresponding SCMFileSystem instance that reflects the content at the specified SCMRevision. If the SCM is supported but not for a fixed revision, best effort is acceptable as the most capable SCMFileSystem will be returned to the caller.

Parameters:

scm - the SCM.

rev - the specified SCMRevision.

Returns:

the corresponding SCMFileSystem or null if this builder cannot create a SCMFileSystem for the specified SCM.

build

@CheckForNull
public SCMFileSystem build(@NonNull
                               SCMSource source,
                               @NonNull
                               SCMHead head,
                               @CheckForNull
                               SCMRevision rev)

Given a SCMSource, a SCMHead and a SCMRevision this method should try to build a corresponding SCMFileSystem instance that reflects the content of the specified SCMHead at the specified SCMRevision. If the SCMSource is supported but not for a fixed revision, best effort is acceptable as the most capable SCMFileSystem will be returned to the caller.

Parameters:

source - the SCMSource.

head - the specified SCMHead.

rev - the specified SCMRevision.

Returns:

the corresponding SCMFileSystem or null if there is none.