io.jenkins.plugins.checks.github

Class GitHubSCMSourceStatusChecksProperties

java.lang.Object

io.jenkins.plugins.checks.github.GitHubSCMSourceStatusChecksProperties

All Implemented Interfaces:

ExtensionPoint, io.jenkins.plugins.checks.status.StatusChecksProperties

@Extension
public class GitHubSCMSourceStatusChecksProperties
extends Object
implements io.jenkins.plugins.checks.status.StatusChecksProperties

Implementing StatusChecksProperties to retrieve properties from jobs with GitHubSCMSourceStatusChecksTrait.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
GitHubSCMSourceStatusChecksProperties() Default constructor.

Method Summary

Modifier and Type	Method and Description
String	getName(Job<?,?> job) Returns the name configured by user in the GitHubSCMSourceStatusChecksTrait.
boolean	isApplicable(Job<?,?> job) Only applicable to jobs using GitHubSCMSource.
boolean	isSkip(Job<?,?> job) Returns if skip publishing status checks as user configured in the GitHubSCMSourceStatusChecksTrait.

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHubSCMSourceStatusChecksProperties

public GitHubSCMSourceStatusChecksProperties()

Default constructor.

Method Detail

isApplicable

public boolean isApplicable(Job<?,?> job)

Only applicable to jobs using GitHubSCMSource.

Specified by:

isApplicable in interface io.jenkins.plugins.checks.status.StatusChecksProperties

Parameters:

job - a jenkins job

Returns:

true if job is using GitHubSCMSource

getName

public String getName(Job<?,?> job)

Returns the name configured by user in the GitHubSCMSourceStatusChecksTrait.

Specified by:

getName in interface io.jenkins.plugins.checks.status.StatusChecksProperties

Parameters:

job - a jenkins job

Returns:

name of status checks if configured, or a default "Jenkins" will be used.

isSkip

public boolean isSkip(Job<?,?> job)

Returns if skip publishing status checks as user configured in the GitHubSCMSourceStatusChecksTrait.

Specified by:

isSkip in interface io.jenkins.plugins.checks.status.StatusChecksProperties

Parameters:

job - a jenkins job

Returns:

true to skip publishing checks if configured.