Package com.github.kostyasha.github.integration.generic

Class GitHubCause<T extends GitHubCause<T>>

java.lang.Object

hudson.model.Cause

com.github.kostyasha.github.integration.generic.GitHubCause<T>

Direct Known Subclasses:

AbstractGitHubBranchCause, GitHubPRCause

public abstract class GitHubCause<T extends GitHubCause<T>>
extends Cause

Author:

Kanstantsin Shautsou

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Cause

Cause.LegacyCodeCause, Cause.RemoteCause, Cause.UpstreamCause, Cause.UserCause, Cause.UserIdCause

Constructor Summary

Constructors

Constructor	Description
GitHubCause()

Method Summary

Modifier and Type	Method	Description
abstract GitHubSCMHead<T>	createSCMHead(String sourceId)
GitHubSCMRevision	createSCMRevision(String sourceId)
abstract void	fillParameters(List<ParameterValue> params)
String	getAbbreviatedTitle()
String	getGitUrl()
URL	getHtmlUrl()	For printing branch url on left builds panel (build description).
String	getPollingLog()
String	getReason()
Object	getRemoteData()
String	getSshUrl()
String	getTitle()
boolean	isSkip()	When set and event got positive condition says to skip job triggering.
void	setPollingLog(String pollingLog)
void	setPollingLogFile(File logFile)
static <T extends GitHubCause<T>> T	skipTrigger(List<? extends T> causes)
GitHubCause<T>	withGitUrl(String gitUrl)
GitHubCause<T>	withHtmlUrl(URL htmlUrl)
GitHubCause	withLocalRepo(GitHubRepository localRepo)
GitHubCause<T>	withPollingLog(String pollingLog)
GitHubCause<T>	withReason(String reason)
GitHubCause<T>	withRemoteData(Object remoteData)
GitHubCause<T>	withSkip(boolean skip)
GitHubCause<T>	withSshUrl(String sshUrl)
GitHubCause<T>	withTitle(String title)

Methods inherited from class hudson.model.Cause

getShortDescription, onAddedTo, onAddedTo, onLoad, onLoad, print

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHubCause

public GitHubCause()

Method Detail

withLocalRepo

public GitHubCause withLocalRepo(@NonNull
                                 GitHubRepository localRepo)

isSkip

public boolean isSkip()

When set and event got positive condition says to skip job triggering.

withSkip

public GitHubCause<T> withSkip(boolean skip)

getHtmlUrl

@CheckForNull
public URL getHtmlUrl()

For printing branch url on left builds panel (build description).

withHtmlUrl

public GitHubCause<T> withHtmlUrl(URL htmlUrl)

getGitUrl

public String getGitUrl()

withGitUrl

public GitHubCause<T> withGitUrl(String gitUrl)

getSshUrl

public String getSshUrl()

withSshUrl

public GitHubCause<T> withSshUrl(String sshUrl)

getPollingLog

public String getPollingLog()

withPollingLog

public GitHubCause<T> withPollingLog(String pollingLog)

setPollingLog

public void setPollingLog(String pollingLog)

setPollingLogFile

public void setPollingLogFile(File logFile)
                       throws IOException

Throws:

IOException

getReason

public String getReason()

withReason

public GitHubCause<T> withReason(String reason)

getRemoteData

public Object getRemoteData()

withRemoteData

public GitHubCause<T> withRemoteData(Object remoteData)

getTitle

@NonNull
public String getTitle()

Returns:

the title of the cause, never null.

withTitle

public GitHubCause<T> withTitle(String title)

getAbbreviatedTitle

public String getAbbreviatedTitle()

Returns:

at most the first 30 characters of the title, or

fillParameters

public abstract void fillParameters(List<ParameterValue> params)

createSCMHead

public abstract GitHubSCMHead<T> createSCMHead(String sourceId)

createSCMRevision

public GitHubSCMRevision createSCMRevision(String sourceId)

skipTrigger

public static <T extends GitHubCause<T>> T skipTrigger(List<? extends T> causes)