Package hudson.triggers

Class SCMTrigger.SCMTriggerCause

java.lang.Object

hudson.model.Cause

hudson.triggers.SCMTrigger.SCMTriggerCause

Enclosing class:

SCMTrigger

public static class SCMTrigger.SCMTriggerCause
extends Cause

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
SCMTriggerCause()	Deprecated. Use SCMTriggerCause(String).
SCMTriggerCause(File logFile)
SCMTriggerCause(String pollingLog)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Run	getRun()
String	getShortDescription()	One-line human-readable text of the cause.
int	hashCode()
void	onAddedTo(Run build)	Called when the cause is registered.
void	onLoad(Run run)	Called when a build is loaded from disk.

Methods inherited from class hudson.model.Cause

onAddedTo, onLoad, print

Methods inherited from class java.lang.Object

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

Constructor Details

SCMTriggerCause

public SCMTriggerCause(File logFile)
                throws IOException

Throws:

IOException

SCMTriggerCause

public SCMTriggerCause(String pollingLog)

SCMTriggerCause

@Deprecated
public SCMTriggerCause()

Deprecated.

Use SCMTriggerCause(String).

Method Details

onLoad

public void onLoad(Run run)

Description copied from class: Cause

Called when a build is loaded from disk. Useful in case the cause needs to keep a build reference; this ought to be transient.

Overrides:

onLoad in class Cause

onAddedTo

public void onAddedTo(Run build)

Description copied from class: Cause

Called when the cause is registered.

Overrides:

onAddedTo in class Cause

getShortDescription

public String getShortDescription()

Description copied from class: Cause

One-line human-readable text of the cause. Historically, this method's return value was used to render HTML on the UI as well. Since Jenkins 2.315 and 2.303.2, the return value is interpreted as text. To have rich HTML output on the UI, provide a custom description.jelly view for your subclass. See the documentation.

Specified by:

getShortDescription in class Cause

getRun

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
public Run getRun()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object