Package org.jenkinsci.plugins.github_branch_source

Class BranchDiscoveryTrait

java.lang.Object

hudson.model.AbstractDescribableImpl<T>

jenkins.scm.api.trait.SCMTrait<jenkins.scm.api.trait.SCMSourceTrait>

jenkins.scm.api.trait.SCMSourceTrait

org.jenkinsci.plugins.github_branch_source.BranchDiscoveryTrait

All Implemented Interfaces:

ExtensionPoint, Describable<jenkins.scm.api.trait.SCMSourceTrait>

public class BranchDiscoveryTrait
extends jenkins.scm.api.trait.SCMSourceTrait

A Discovery trait for GitHub that will discover branches on the repository.

Since:

2.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BranchDiscoveryTrait.BranchSCMHeadAuthority	Trusts branches from the origin repository.
static class	BranchDiscoveryTrait.DescriptorImpl	Our descriptor.
static class	BranchDiscoveryTrait.ExcludeOriginPRBranchesSCMHeadFilter	Filter that excludes branches that are also filed as a pull request.
static class	BranchDiscoveryTrait.OnlyOriginPRBranchesSCMHeadFilter	Filter that excludes branches that are not also filed as a pull request.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALL_BRANCHES	All branches.
static final int	EXCLUDE_PRS	Exclude branches that are also filed as PRs.
static final int	NONE	None strategy.
static final int	ONLY_PRS	Only branches that are also filed as PRs.

Constructor Summary

Constructors

Constructor	Description
BranchDiscoveryTrait(boolean buildBranch, boolean buildBranchWithPr)	Constructor for legacy code.
BranchDiscoveryTrait(int strategyId)	Constructor for stapler.

Method Summary

Modifier and Type	Method	Description
protected void	decorateContext(jenkins.scm.api.trait.SCMSourceContext<?,?> context)
int	getStrategyId()	Returns the strategy id.
boolean	includeCategory(jenkins.scm.api.SCMHeadCategory category)
boolean	isBuildBranch()	Returns true if building branches that are not filed as a PR.
boolean	isBuildBranchesWithPR()	Returns true if building branches that are filed as a PR.

Methods inherited from class jenkins.scm.api.trait.SCMSourceTrait

_for, _for, all, applyToBuilder, applyToContext, applyToObserver, decorateBuilder, decorateObserver, getDescriptor, isCategoryEnabled

Methods inherited from class jenkins.scm.api.trait.SCMTrait

asSetList, asSetList, find

Methods inherited from class java.lang.Object

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

Field Details

NONE

public static final int NONE

None strategy.

See Also:

• Constant Field Values

EXCLUDE_PRS

public static final int EXCLUDE_PRS

Exclude branches that are also filed as PRs.

See Also:

• Constant Field Values

ONLY_PRS

public static final int ONLY_PRS

Only branches that are also filed as PRs.

See Also:

• Constant Field Values

ALL_BRANCHES

public static final int ALL_BRANCHES

All branches.

See Also:

• Constant Field Values

Constructor Details

BranchDiscoveryTrait

@DataBoundConstructor
public BranchDiscoveryTrait(int strategyId)

Constructor for stapler.

Parameters:

strategyId - the strategy id.

BranchDiscoveryTrait

public BranchDiscoveryTrait(boolean buildBranch,
 boolean buildBranchWithPr)

Constructor for legacy code.

Parameters:

buildBranch - build branches that are not filed as a PR.

buildBranchWithPr - build branches that are also PRs.

Method Details

getStrategyId

public int getStrategyId()

Returns the strategy id.

Returns:

the strategy id.

isBuildBranch

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

Returns true if building branches that are not filed as a PR.

Returns:

true if building branches that are not filed as a PR.

isBuildBranchesWithPR

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

Returns true if building branches that are filed as a PR.

Returns:

true if building branches that are filed as a PR.

decorateContext

protected void decorateContext(jenkins.scm.api.trait.SCMSourceContext<?,?> context)

Overrides:

decorateContext in class jenkins.scm.api.trait.SCMSourceTrait

includeCategory

public boolean includeCategory(@NonNull
 jenkins.scm.api.SCMHeadCategory category)

Overrides:

includeCategory in class jenkins.scm.api.trait.SCMSourceTrait