Package hudson.model

Class Cause.UpstreamCause

java.lang.Object

hudson.model.Cause

hudson.model.Cause.UpstreamCause

Enclosing class:

Cause

public static class Cause.UpstreamCause
extends Cause

A build is triggered by another build (AKA upstream build.)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Cause.UpstreamCause.ConverterImpl
static class	Cause.UpstreamCause.DeeplyNestedUpstreamCause

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

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

Constructor Summary

Constructors

Constructor	Description
UpstreamCause(AbstractBuild<?,?> up)	Deprecated. since 2009-02-28
UpstreamCause(Run<?,?> up)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object rhs)
String	getShortDescription()	One-line human-readable text of the cause.
int	getUpstreamBuild()
List<Cause>	getUpstreamCauses()
String	getUpstreamProject()
Run<?,?>	getUpstreamRun()
String	getUpstreamUrl()
int	hashCode()
void	onLoad(Job<?,?> _job, int _buildNumber)
boolean	pointsTo(Job<?,?> j)	Returns true if this cause points to a build in the specified job.
boolean	pointsTo(Run<?,?> r)	Returns true if this cause points to the specified build.
void	print(TaskListener listener)	Report a line to the listener about this cause.
String	toString()

Methods inherited from class hudson.model.Cause

onAddedTo, onAddedTo, onLoad, onLoad

Methods inherited from class java.lang.Object

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

Constructor Detail

UpstreamCause

@Deprecated
public UpstreamCause(AbstractBuild<?,?> up)

Deprecated.

since 2009-02-28

UpstreamCause

public UpstreamCause(Run<?,?> up)

Method Detail

onLoad

public void onLoad(@NonNull
                   Job<?,?> _job,
                   int _buildNumber)

equals

public boolean equals(Object rhs)

Overrides:

equals in class Object

Since:

1.515

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

1.515

pointsTo

public boolean pointsTo(Job<?,?> j)

Returns true if this cause points to a build in the specified job.

pointsTo

public boolean pointsTo(Run<?,?> r)

Returns true if this cause points to the specified build.

getUpstreamProject

@Exported(visibility=3)
public String getUpstreamProject()

getUpstreamBuild

@Exported(visibility=3)
public int getUpstreamBuild()

getUpstreamRun

@CheckForNull
public Run<?,?> getUpstreamRun()

Since:

1.505

getUpstreamUrl

@Exported(visibility=3)
public String getUpstreamUrl()

getUpstreamCauses

public List<Cause> getUpstreamCauses()

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

print

public void print(TaskListener listener)

Description copied from class: Cause

Report a line to the listener about this cause.

Overrides:

print in class Cause

toString

public String toString()

Overrides:

toString in class Object