Package com.atlassian.bamboo.plugins.github

Class GithubPullRequestDetector

java.lang.Object

com.atlassian.bamboo.plugins.github.GithubPullRequestDetector

All Implemented Interfaces:

IdentifyingExecutor<VcsPullRequestDetector>, VcsPullRequestDetector

public class GithubPullRequestDetector
extends Object
implements VcsPullRequestDetector

Constructor Summary

Constructors

Constructor	Description
GithubPullRequestDetector()

Method Summary

Modifier and Type	Method	Description
@NotNull List<VcsPullRequest>	getOpenPullRequests(@NotNull VcsRepositoryData repositoryData)	List of open pull requests that are discovered in the repository.
protected List<GithubPullRequestDto>	getPullRequestsByRepository(@NotNull VcsRepositoryData repositoryData, @NotNull GitHubAccessor gitHubAccessor)
@Nullable ContextualVcsId<VcsPullRequestDetector>	getVcsIdForExecutor(@NotNull VcsRepositoryData vcsRepositoryData)	Returned id has to fulfill the following: Given two VcsRepositoryData objects A and B, and executor e returning equal ContextualVcsId (in terms of equals()), for any operation foo() provided by the executor, the calls e::foo(A) and e::foo(B) should be equivalent.
boolean	supportsForkedPullRequests()	Whether pull requests from forked repositories are handled.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.vcs.runtime.VcsPullRequestDetector

usePollingForPullRequestDetection

Constructor Detail

GithubPullRequestDetector

public GithubPullRequestDetector()

Method Detail

getVcsIdForExecutor

@Nullable
public @Nullable ContextualVcsId<VcsPullRequestDetector> getVcsIdForExecutor(@NotNull
                                                                             @NotNull VcsRepositoryData vcsRepositoryData)

Description copied from interface: IdentifyingExecutor

Returned id has to fulfill the following: Given two VcsRepositoryData objects A and B, and executor e returning equal ContextualVcsId (in terms of equals()), for any operation foo() provided by the executor, the calls e::foo(A) and e::foo(B) should be equivalent. To be more precise: given any time point t and any variable context v, calling a::foo(A) should yield the same results as calling e::foo(B). Given the above it follows that - calculation of the id should take into account global and plan variables. This means, that calling this method on the same object in different variable context can (possibly must) yield different results. - equal ids need not (and should not) guarantee equal call results over indefinite time. In particular, result of e:foo(A).equals(e::foo(A)) is allowed to be false, since 2 calls to e::foo(A) do not happen at the same time. Example: 2 git repositories with the same url and credentials are considered equal in context of VcsBranchDetector. If they also point to the same branch, they are considered equal in context of VcsChangeDetector

Specified by:

getVcsIdForExecutor in interface IdentifyingExecutor<VcsPullRequestDetector>

Returns:

the id of repository, can be null if no feasible identification algorithm exists

getOpenPullRequests

@NotNull
public @NotNull List<VcsPullRequest> getOpenPullRequests(@NotNull
                                                         @NotNull VcsRepositoryData repositoryData)
                                                  throws RepositoryException

Description copied from interface: VcsPullRequestDetector

List of open pull requests that are discovered in the repository. Used for monitoring repositories for new PRs.

Specified by:

getOpenPullRequests in interface VcsPullRequestDetector

Parameters:

repositoryData - repository

Returns:

List of open pull requests. May be empty.

Throws:

RepositoryException

getPullRequestsByRepository

@VisibleForTesting
protected List<GithubPullRequestDto> getPullRequestsByRepository(@NotNull
                                                                 @NotNull VcsRepositoryData repositoryData,
                                                                 @NotNull
                                                                 @NotNull GitHubAccessor gitHubAccessor)
                                                          throws RepositoryException

Throws:

RepositoryException

supportsForkedPullRequests

public boolean supportsForkedPullRequests()

Description copied from interface: VcsPullRequestDetector

Whether pull requests from forked repositories are handled.

Specified by:

supportsForkedPullRequests in interface VcsPullRequestDetector

Returns:

- true if detector supports pull requests from forked repositories - false if it does not