Package org.jenkinsci.plugins.github_branch_source

Class GitHubSCMFileSystem

java.lang.Object

jenkins.scm.api.SCMFileSystem

org.jenkinsci.plugins.github_branch_source.GitHubSCMFileSystem

All Implemented Interfaces:

Closeable, AutoCloseable

public class GitHubSCMFileSystem
extends jenkins.scm.api.SCMFileSystem

Implements SCMFileSystem for GitHub.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubSCMFileSystem.BuilderImpl

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

jenkins.scm.api.SCMFileSystem.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GitHubSCMFileSystem(org.kohsuke.github.GitHub gitHub, org.kohsuke.github.GHRepository repo, String refName, jenkins.scm.api.SCMRevision rev)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	changesSince(jenkins.scm.api.SCMRevision revision, OutputStream changeLogStream)
void	close()
jenkins.scm.api.SCMFile	getRoot()
boolean	isOpen()
long	lastModified()

Methods inherited from class jenkins.scm.api.SCMFileSystem

child, getRevision, isFixedRevision, of, of, of, of, of, supports, supports, supports, supports

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHubSCMFileSystem

protected GitHubSCMFileSystem(org.kohsuke.github.GitHub gitHub,
                              org.kohsuke.github.GHRepository repo,
                              String refName,
                              @CheckForNull
                              jenkins.scm.api.SCMRevision rev)
                       throws IOException

Constructor.

Parameters:

gitHub - the GitHub

repo - the GHRepository

refName - the ref name, e.g. heads/branchName, tags/tagName, pull/N/head or the SHA.

rev - the optional revision.

Throws:

IOException - if I/O errors occur.

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class jenkins.scm.api.SCMFileSystem

Throws:

IOException

isOpen

public boolean isOpen()

lastModified

public long lastModified()
                  throws IOException

Specified by:

lastModified in class jenkins.scm.api.SCMFileSystem

Throws:

IOException

changesSince

public boolean changesSince(jenkins.scm.api.SCMRevision revision,
                            @NonNull
                            OutputStream changeLogStream)
                     throws UnsupportedOperationException,
                            IOException,
                            InterruptedException

Overrides:

changesSince in class jenkins.scm.api.SCMFileSystem

Throws:

UnsupportedOperationException

IOException

InterruptedException

getRoot

@NonNull
public jenkins.scm.api.SCMFile getRoot()

Specified by:

getRoot in class jenkins.scm.api.SCMFileSystem