Package com.github.kostyasha.github.integration.generic

Class GitHubBranchDecisionContext

java.lang.Object

com.github.kostyasha.github.integration.generic.GitHubDecisionContext<GitHubBranchEvent,GitHubBranchCause>

com.github.kostyasha.github.integration.generic.GitHubBranchDecisionContext

public class GitHubBranchDecisionContext
extends GitHubDecisionContext<GitHubBranchEvent,GitHubBranchCause>

Author:

Kanstantsin Shautsou

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubBranchDecisionContext.Builder

Constructor Summary

Constructors

Constructor	Description
GitHubBranchDecisionContext(org.kohsuke.github.GHBranch remoteBranch, GitHubBranch localBranch, GitHubBranchRepository localRepo, GitHubBranchHandler branchHandler, GitHubSCMSource scmSource, GitHubBranchTrigger branchTrigger, TaskListener listener)

Method Summary

Modifier and Type	Method	Description
GitHubBranchCause	checkEvent(GitHubBranchEvent event)
GitHubBranchTrigger	getBranchTrigger()	Deprecated.
GitHubBranchHandler	getHandler()
GitHubBranch	getLocalBranch()
GitHubBranchRepository	getLocalRepo()
org.kohsuke.github.GHBranch	getRemoteBranch()
GitHubBranchTrigger	getTrigger()
GitHubBranchCause	newCause(String reason, boolean skip)
static GitHubBranchDecisionContext.Builder	newGitHubBranchDecisionContext()

Methods inherited from class com.github.kostyasha.github.integration.generic.GitHubDecisionContext

getListener, getRemoteRepository, getScmSource

Methods inherited from class java.lang.Object

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

Constructor Details

GitHubBranchDecisionContext

public GitHubBranchDecisionContext(org.kohsuke.github.GHBranch remoteBranch,
 GitHubBranch localBranch,
 @NonNull
 GitHubBranchRepository localRepo,
 GitHubBranchHandler branchHandler,
 GitHubSCMSource scmSource,
 GitHubBranchTrigger branchTrigger,
 TaskListener listener)

Method Details

getRemoteBranch

@CheckForNull
public org.kohsuke.github.GHBranch getRemoteBranch()

Returns:

current branch state fetched from GH.

getLocalBranch

@CheckForNull
public GitHubBranch getLocalBranch()

Returns:

branch state from last run saved in jenkins. null when not exist before.

getLocalRepo

@NonNull
public GitHubBranchRepository getLocalRepo()

Returns:

local repository state. Useful to extract repo URLs for example.

getTrigger

public GitHubBranchTrigger getTrigger()

Overrides:

getTrigger in class GitHubDecisionContext<GitHubBranchEvent,GitHubBranchCause>

getHandler

public GitHubBranchHandler getHandler()

Overrides:

getHandler in class GitHubDecisionContext<GitHubBranchEvent,GitHubBranchCause>

getBranchTrigger

@Deprecated
public GitHubBranchTrigger getBranchTrigger()

Deprecated.

checkEvent

public GitHubBranchCause checkEvent(GitHubBranchEvent event)
                             throws IOException

Specified by:

checkEvent in class GitHubDecisionContext<GitHubBranchEvent,GitHubBranchCause>

Throws:

IOException

newCause

public GitHubBranchCause newCause(String reason,
 boolean skip)

Specified by:

newCause in class GitHubDecisionContext<GitHubBranchEvent,GitHubBranchCause>

newGitHubBranchDecisionContext

@NonNull
public static GitHubBranchDecisionContext.Builder newGitHubBranchDecisionContext()