Package org.jenkinsci.plugins.github_branch_source

Class GitHubSCMNavigatorContext

java.lang.Object

jenkins.scm.api.trait.SCMNavigatorContext<GitHubSCMNavigatorContext,GitHubSCMNavigatorRequest>

org.jenkinsci.plugins.github_branch_source.GitHubSCMNavigatorContext

public class GitHubSCMNavigatorContext
extends jenkins.scm.api.trait.SCMNavigatorContext<GitHubSCMNavigatorContext,GitHubSCMNavigatorRequest>

The SCMNavigatorContext for GitHub.

Since:

2.2.0

Constructor Summary

Constructors

Constructor	Description
GitHubSCMNavigatorContext()

Method Summary

Modifier and Type	Method	Description
String	getTeamSlug()	Gets the name of the team who's repositories will be navigated.
List<String>	getTopics()	Gets the topics which the repositories must have.
boolean	isExcludeArchivedRepositories()
boolean	isExcludeForkedRepositories()
boolean	isExcludePrivateRepositories()
boolean	isExcludePublicRepositories()
GitHubSCMNavigatorRequest	newRequest(jenkins.scm.api.SCMNavigator navigator, jenkins.scm.api.SCMSourceObserver observer)
void	setExcludeArchivedRepositories(boolean excludeArchivedRepositories)
void	setExcludeForkedRepositories(boolean excludeForkedRepositories)
void	setExcludePrivateRepositories(boolean excludePrivateRepositories)
void	setExcludePublicRepositories(boolean excludePublicRepositories)
void	setTopics(List<String> topics)	Sets the topics which the repositories must have.

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

decorators, filters, prefilters, traits, withDecorator, withDecorators, withDecorators, withFilter, withPrefilter, withTrait, withTrait, withTraits, withTraits

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHubSCMNavigatorContext

public GitHubSCMNavigatorContext()

Method Detail

newRequest

@NonNull
public GitHubSCMNavigatorRequest newRequest(@NonNull
                                            jenkins.scm.api.SCMNavigator navigator,
                                            @NonNull
                                            jenkins.scm.api.SCMSourceObserver observer)

Specified by:

newRequest in class jenkins.scm.api.trait.SCMNavigatorContext<GitHubSCMNavigatorContext,GitHubSCMNavigatorRequest>

getTeamSlug

public String getTeamSlug()

Gets the name of the team who's repositories will be navigated.

Returns:

teamSlug

setTopics

public void setTopics(List<String> topics)

Sets the topics which the repositories must have.

getTopics

public List<String> getTopics()

Gets the topics which the repositories must have.

Returns:

topics

isExcludeArchivedRepositories

public boolean isExcludeArchivedRepositories()

Returns:

True if archived repositories should be ignored, false if they should be included.

isExcludePublicRepositories

public boolean isExcludePublicRepositories()

Returns:

True if public repositories should be ignored, false if they should be included.

isExcludePrivateRepositories

public boolean isExcludePrivateRepositories()

Returns:

True if private repositories should be ignored, false if they should be included.

isExcludeForkedRepositories

public boolean isExcludeForkedRepositories()

Returns:

True if forked repositories should be ignored, false if they should be included.

setExcludeArchivedRepositories

public void setExcludeArchivedRepositories(boolean excludeArchivedRepositories)

Parameters:

excludeArchivedRepositories - Set true to exclude archived repositories

setExcludePublicRepositories

public void setExcludePublicRepositories(boolean excludePublicRepositories)

Parameters:

excludePublicRepositories - Set true to exclude public repositories

setExcludePrivateRepositories

public void setExcludePrivateRepositories(boolean excludePrivateRepositories)

Parameters:

excludePrivateRepositories - Set true to exclude private repositories

setExcludeForkedRepositories

public void setExcludeForkedRepositories(boolean excludeForkedRepositories)

Parameters:

excludeForkedRepositories - Set true to exclude archived repositories