Package org.jenkinsci.plugins.github_branch_source

Class ForkPullRequestDiscoveryTrait

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.ForkPullRequestDiscoveryTrait

All Implemented Interfaces:

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

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

A Discovery trait for GitHub that will discover pull requests from forks of the repository.

Since:

2.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ForkPullRequestDiscoveryTrait.DescriptorImpl	Our descriptor.
static class	ForkPullRequestDiscoveryTrait.TrustContributors	An SCMHeadAuthority that trusts contributors to the repository.
static class	ForkPullRequestDiscoveryTrait.TrustEveryone	An SCMHeadAuthority that trusts everyone.
static class	ForkPullRequestDiscoveryTrait.TrustNobody	An SCMHeadAuthority that trusts nothing.
static class	ForkPullRequestDiscoveryTrait.TrustPermission	An SCMHeadAuthority that trusts those with write permission to the repository.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static int	HEAD	The current pull request revision.
static int	HEAD_AND_MERGE	Both the current pull request revision and the pull request merged with the current target branch revision.
static int	MERGE	Merging the pull request with the current target branch revision.
static int	NONE	None strategy.

Constructor Summary

Constructors

Constructor	Description
ForkPullRequestDiscoveryTrait(int strategyId, jenkins.scm.api.trait.SCMHeadAuthority<? super GitHubSCMSourceRequest,? extends jenkins.scm.api.mixin.ChangeRequestSCMHead2,? extends jenkins.scm.api.SCMRevision> trust)	Constructor for stapler.
ForkPullRequestDiscoveryTrait(Set<jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy> strategies, jenkins.scm.api.trait.SCMHeadAuthority<? super GitHubSCMSourceRequest,? extends jenkins.scm.api.mixin.ChangeRequestSCMHead2,? extends jenkins.scm.api.SCMRevision> trust)	Constructor for programmatic instantiation.

Method Summary

Modifier and Type	Method	Description
protected void	decorateContext(jenkins.scm.api.trait.SCMSourceContext<?,?> context)
Set<jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy>	getStrategies()	Returns the strategies.
int	getStrategyId()	Gets the strategy id.
jenkins.scm.api.trait.SCMHeadAuthority<? super GitHubSCMSourceRequest,? extends jenkins.scm.api.mixin.ChangeRequestSCMHead2,? extends jenkins.scm.api.SCMRevision>	getTrust()	Gets the authority.
boolean	includeCategory(jenkins.scm.api.SCMHeadCategory category)

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 Detail

NONE

public static final int NONE

None strategy.

See Also:

Constant Field Values

MERGE

public static final int MERGE

Merging the pull request with the current target branch revision.

See Also:

Constant Field Values

HEAD

public static final int HEAD

The current pull request revision.

See Also:

Constant Field Values

HEAD_AND_MERGE

public static final int HEAD_AND_MERGE

Both the current pull request revision and the pull request merged with the current target branch revision.

See Also:

Constant Field Values

Constructor Detail

ForkPullRequestDiscoveryTrait

@DataBoundConstructor
public ForkPullRequestDiscoveryTrait(int strategyId,
                                     @NonNull
                                     jenkins.scm.api.trait.SCMHeadAuthority<? super GitHubSCMSourceRequest,? extends jenkins.scm.api.mixin.ChangeRequestSCMHead2,? extends jenkins.scm.api.SCMRevision> trust)

Constructor for stapler.

Parameters:

strategyId - the strategy id.

trust - the authority to use.

ForkPullRequestDiscoveryTrait

public ForkPullRequestDiscoveryTrait(@NonNull
                                     Set<jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy> strategies,
                                     @NonNull
                                     jenkins.scm.api.trait.SCMHeadAuthority<? super GitHubSCMSourceRequest,? extends jenkins.scm.api.mixin.ChangeRequestSCMHead2,? extends jenkins.scm.api.SCMRevision> trust)

Constructor for programmatic instantiation.

Parameters:

strategies - the ChangeRequestCheckoutStrategy instances.

trust - the authority.

Method Detail

getStrategyId

public int getStrategyId()

Gets the strategy id.

Returns:

the strategy id.

getStrategies

@NonNull
public Set<jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy> getStrategies()

Returns the strategies.

Returns:

the strategies.

getTrust

@NonNull
public jenkins.scm.api.trait.SCMHeadAuthority<? super GitHubSCMSourceRequest,? extends jenkins.scm.api.mixin.ChangeRequestSCMHead2,? extends jenkins.scm.api.SCMRevision> getTrust()

Gets the authority.

Returns:

the authority.

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