Package com.github.kostyasha.github.integration.branch.events.impl

Class GitHubBranchCommitEvent

java.lang.Object

hudson.model.AbstractDescribableImpl<GitHubBranchEvent>

com.github.kostyasha.github.integration.branch.events.GitHubBranchEvent

com.github.kostyasha.github.integration.branch.events.impl.GitHubBranchCommitEvent

All Implemented Interfaces:

ExtensionPoint, Describable<GitHubBranchEvent>

public class GitHubBranchCommitEvent
extends GitHubBranchEvent

This branch event acts as a wrapper around checks that can be performed against commit data that requires an additional round trip to GitHub to retrieve.

Commit data is retrieved and then passed to each implementing instance of GitHubBranchCommitCheck to determine information about the commit should trigger a build.

Author:

Kanstantsin Shautsou, Jae Gangemi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubBranchCommitEvent.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
GitHubBranchCommitEvent()	For groovy UI
GitHubBranchCommitEvent(List<GitHubBranchCommitCheck> checks)

Method Summary

Modifier and Type	Method	Description
GitHubBranchCause	check(GitHubBranchDecisionContext context)	indicates that branch was created
List<GitHubBranchCommitCheck>	getChecks()
void	setChecks(List<GitHubBranchCommitCheck> checks)

Methods inherited from class com.github.kostyasha.github.integration.branch.events.GitHubBranchEvent

checkHook, getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

GitHubBranchCommitEvent

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public GitHubBranchCommitEvent()

For groovy UI

GitHubBranchCommitEvent

@DataBoundConstructor
public GitHubBranchCommitEvent(List<GitHubBranchCommitCheck> checks)

Method Details

check

public GitHubBranchCause check(@NonNull
 GitHubBranchDecisionContext context)
                        throws IOException

Description copied from class: GitHubBranchEvent

indicates that branch was created

Overrides:

check in class GitHubBranchEvent

Returns:

cause object. null when no influence (other events will be checked. If cause.isSkip() == true, then other checks wouldn't influence. And triggering for this branch will be skipped. If cause.isSkip() == false, indicates that branch build should be run.

Throws:

IOException

getChecks

@NonNull
public List<GitHubBranchCommitCheck> getChecks()

setChecks

public void setChecks(List<GitHubBranchCommitCheck> checks)