jenkins.scm.api

Class SCMFileSystem

java.lang.Object

jenkins.scm.api.SCMFileSystem

public abstract class SCMFileSystem
extends Object

A virtual file system for a specific SCM potentially pinned to a specific SCMRevision.

Author:

Stephen Connolly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SCMFileSystem.Builder 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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SCMFileSystem(SCMRevision rev)

Method Summary

Methods

Modifier and Type	Method and Description
SCMFile	get(String path) Short for getRoot().get(path)
SCMRevision	getRevision() If this inspector is looking at the specific commit, returns that revision.
abstract SCMFile	getRoot() Returns the SCMFile object that represents the root directory of the repository.
boolean	isFixedRevision() Whether this inspector is looking at the specific commit.
static SCMFileSystem	of(hudson.scm.SCM scm) Given a SCM this method will try to retrieve a corresponding SCMFileSystem instance.
static SCMFileSystem	of(hudson.scm.SCM scm, SCMRevision rev) Given a SCM this method will try to retrieve a corresponding SCMFileSystem instance that reflects the content at the specified SCMRevision.
static SCMFileSystem	of(SCMSource source, SCMHead head) Given a SCMSource and a SCMHead this method will try to retrieve a corresponding SCMFileSystem instance that reflects the content of the specified SCMHead.
static SCMFileSystem	of(SCMSource source, SCMHead head, SCMRevision rev) Given a SCMSource, a SCMHead and a SCMRevision this method will try to retrieve 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

protected SCMFileSystem(@CheckForNull
             SCMRevision rev)

Method Detail

getRevision

@CheckForNull
public SCMRevision getRevision()

If this inspector is looking at the specific commit, returns that revision. Otherwise null, indicating that the inspector is looking at just the latest state of the repository.

isFixedRevision

public final boolean isFixedRevision()

Whether this inspector is looking at the specific commit.

Short for getRevision()!=null.

get

@CheckForNull
public final SCMFile get(@NonNull
                       String path)
                  throws IOException

Short for getRoot().get(path)

Throws:

IOException

getRoot

@NonNull
public abstract SCMFile getRoot()
                         throws IOException

Returns the SCMFile object that represents the root directory of the repository.

Throws:

IOException

of

@CheckForNull
public static SCMFileSystem of(@NonNull
                            hudson.scm.SCM scm)

Given a SCM this method will try to retrieve a corresponding SCMFileSystem instance.

Parameters:

scm - the SCM.

Returns:

the corresponding SCMFileSystem or null if there is none.

of

@CheckForNull
public static SCMFileSystem of(@NonNull
                            hudson.scm.SCM scm,
                            @CheckForNull
                            SCMRevision rev)

Given a SCM this method will try to retrieve a corresponding SCMFileSystem instance that reflects the content at the specified SCMRevision.

Parameters:

scm - the SCM.

rev - the specified SCMRevision.

Returns:

the corresponding SCMFileSystem or null if there is none.

of

@CheckForNull
public static SCMFileSystem of(@NonNull
                            SCMSource source,
                            @NonNull
                            SCMHead head)

Given a SCMSource and a SCMHead this method will try to retrieve a corresponding SCMFileSystem instance that reflects the content of the specified SCMHead.

Parameters:

source - the SCMSource.

head - the specified SCMHead.

Returns:

the corresponding SCMFileSystem or null if there is none.

of

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

Given a SCMSource, a SCMHead and a SCMRevision this method will try to retrieve a corresponding SCMFileSystem instance that reflects the content of the specified SCMHead at the specified SCMRevision.

Parameters:

source - the SCMSource.

head - the specified SCMHead.

rev - the specified SCMRevision.

Returns:

the corresponding SCMFileSystem or null if there is none.