Package hudson.model

Class Cause.UserIdCause

java.lang.Object

hudson.model.Cause

hudson.model.Cause.UserIdCause

Direct Known Subclasses:

BuildCommand.CLICause

Enclosing class:

Cause

public static class Cause.UserIdCause
extends Cause

A build is started by an user action.

Since:

1.427

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
UserIdCause()	Constructor, which uses the current User.
UserIdCause(String userId)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getShortDescription()	One-line human-readable text of the cause.
String	getUserId()
String	getUserName()
String	getUserUrl()
int	hashCode()
void	print(TaskListener listener)	Report a line to the listener about this cause.

Methods inherited from class hudson.model.Cause

onAddedTo, onAddedTo, onLoad, onLoad

Methods inherited from class java.lang.Object

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

Constructor Details

UserIdCause

public UserIdCause()

Constructor, which uses the current User.

UserIdCause

public UserIdCause(@CheckForNull
 String userId)

Constructor.

Parameters:

userId - User ID. null if the user is unknown.

Since:

2.96

Method Details

getUserId

@Exported(visibility=3)
@CheckForNull
public String getUserId()

getUserName

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

getUserUrl

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@CheckForNull
public String getUserUrl()

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object