Package com.adobe.jenkins.github_pr_comment_build

Class GitHubPullRequestCommentCause

java.lang.Object

hudson.model.Cause

com.adobe.jenkins.github_pr_comment_build.GitHubPullRequestCommentCause

All Implemented Interfaces:

Serializable

public final class GitHubPullRequestCommentCause
extends Cause
implements Serializable

Created by saville on 10/13/2016.

See Also:

• Serialized Form

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
GitHubPullRequestCommentCause(String commentUrl, String commentAuthor, String commentBody)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getCommentAuthor()	Retrieves the author of the GitHub comment for this cause.
String	getCommentBody()	Retrieves the body for the GitHub comment for this cause.
String	getCommentUrl()	Retrieves the URL for the GitHub comment for this cause.
String	getShortDescription()

Methods inherited from class hudson.model.Cause

onAddedTo, onAddedTo, onLoad, onLoad, print

Methods inherited from class java.lang.Object

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

Constructor Details

GitHubPullRequestCommentCause

public GitHubPullRequestCommentCause(String commentUrl,
 String commentAuthor,
 String commentBody)

Constructor.

Parameters:

commentUrl - the URL for the GitHub comment

commentAuthor - the author of the GitHub comment

commentBody - the body for the GitHub comment

Method Details

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in class Cause

getCommentUrl

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

Retrieves the URL for the GitHub comment for this cause.

Returns:

the URL for the GitHub comment

getCommentAuthor

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

Retrieves the author of the GitHub comment for this cause.

Returns:

the author of the GitHub comment

getCommentBody

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

Retrieves the body for the GitHub comment for this cause.

Returns:

the body for the GitHub comment