Module org.kohsuke.github.api

Package org.kohsuke.github

Class GHPullRequestReviewComment

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHIssueComment

org.kohsuke.github.GHPullRequestReviewComment

All Implemented Interfaces:

Reactable, Refreshable

public class GHPullRequestReviewComment
extends GHIssueComment
implements Refreshable

Review comment to the pull request.

Author:

Julien Henry

See Also:

• GHPullRequest#listReviewComments()
• GHPullRequest#createReviewComment(String, String, String, int)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GHPullRequestReviewComment.Side	The side of the diff to which the comment applies.

Field Summary

Fields inherited from class org.kohsuke.github.GHIssueComment

authorAssociation, body, bodyHtml, bodyText, htmlUrl, user

Fields inherited from class org.kohsuke.github.GHObject

responseHeaderFields

Constructor Summary

Constructors

Constructor	Description
GHPullRequestReviewComment()	Create default GHPullRequestReviewComment instance

Method Summary

Modifier and Type	Method	Description
GHReaction	createReaction(ReactionContent content)	Creates the reaction.
void	delete()	Deletes this review comment.
void	deleteReaction(GHReaction reaction)	Delete reaction.
protected String	getApiRoute()	Gets api route.
protected String	getApiRoute(boolean includePullNumber)	Gets api route.
String	getCommitId()	Gets commit id.
String	getDiffHunk()	Gets diff hunk.
long	getInReplyToId()	Gets in reply to id.
int	getLine()	Gets The line of the blob to which the comment applies.
String	getOriginalCommitId()	Gets commit id.
int	getOriginalLine()	Gets The line of the blob to which the comment applies.
int	getOriginalPosition()	Gets original position.
int	getOriginalStartLine()	Gets The first line of the range for a multi-line comment.
GHPullRequest	getParent()	Gets the pull request to which this review comment is associated.
String	getPath()	Gets path.
int	getPosition()	Gets position.
Long	getPullRequestReviewId()	Gets The ID of the pull request review to which the comment belongs.
URL	getPullRequestUrl()	Gets URL for the pull request that the review comment belongs to.
GHPullRequestReviewCommentReactions	getReactions()	Gets the Reaction Rollup
GHPullRequestReviewComment.Side	getSide()	Gets The side of the diff to which the comment applies.
int	getStartLine()	Gets The first line of the range for a multi-line comment.
GHPullRequestReviewComment.Side	getStartSide()	Gets The side of the first line of the range for a multi-line comment.
GHUser	getUser()	Gets the user who posted this comment.
PagedIterable<GHReaction>	listReactions()	List reactions.
void	refresh()	Refreshes this comment by fetching the full data from the API.
GHPullRequestReviewComment	reply(String body)	Create a new comment that replies to this comment.
void	update(String body)	Updates the comment.

Methods inherited from class org.kohsuke.github.GHIssueComment

getAuthorAssociation, getBody, getBodyHtml, getBodyText, getHtmlUrl

Methods inherited from class org.kohsuke.github.GHObject

getCreatedAt, getId, getNodeId, getResponseHeaderFields, getUpdatedAt, getUrl, setResponseHeaderFields, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kohsuke.github.Refreshable

refresh

Constructor Details

GHPullRequestReviewComment

public GHPullRequestReviewComment()

Create default GHPullRequestReviewComment instance

Method Details

createReaction

public GHReaction createReaction(ReactionContent content)
                          throws IOException

Creates the reaction.

Specified by:

createReaction in interface Reactable

Overrides:

createReaction in class GHIssueComment

Parameters:

content - the content

Returns:

the GH reaction

Throws:

IOException - Signals that an I/O exception has occurred.

delete

public void delete()
            throws IOException

Deletes this review comment.

Overrides:

delete in class GHIssueComment

Throws:

IOException - the io exception

deleteReaction

public void deleteReaction(GHReaction reaction)
                    throws IOException

Delete reaction.

Specified by:

deleteReaction in interface Reactable

Overrides:

deleteReaction in class GHIssueComment

Parameters:

reaction - the reaction

Throws:

IOException - Signals that an I/O exception has occurred.

getCommitId

public String getCommitId()

Gets commit id.

Returns:

the commit id

getDiffHunk

public String getDiffHunk()

Gets diff hunk.

Returns:

the diff hunk

getInReplyToId

public long getInReplyToId()

Gets in reply to id.

Returns:

the in reply to id, or -1 if not a reply

getLine

public int getLine()

Gets The line of the blob to which the comment applies. The last line of the range for a multi-line comment.

This field is not available on GHPullRequestReview.ReviewComment objects returned by GHPullRequestReview.listReviewComments(). Use GHPullRequestReview.ReviewComment.readPullRequestReviewComment() or GHPullRequest.listReviewComments() to obtain this value.

Returns:

the line to which the comment applies, or -1 if not available

getOriginalCommitId

public String getOriginalCommitId()

Gets commit id.

Returns:

the commit id

getOriginalLine

public int getOriginalLine()

Gets The line of the blob to which the comment applies. The last line of the range for a multi-line comment.

This field is not available on GHPullRequestReview.ReviewComment objects returned by GHPullRequestReview.listReviewComments(). Use GHPullRequestReview.ReviewComment.readPullRequestReviewComment() or GHPullRequest.listReviewComments() to obtain this value.

Returns:

the line to which the comment applies, or -1 if not available

getOriginalPosition

public int getOriginalPosition()

Gets original position.

Returns:

the original position

getOriginalStartLine

public int getOriginalStartLine()

Gets The first line of the range for a multi-line comment.

This field is not available on GHPullRequestReview.ReviewComment objects returned by GHPullRequestReview.listReviewComments(). Use GHPullRequestReview.ReviewComment.readPullRequestReviewComment() or GHPullRequest.listReviewComments() to obtain this value.

Returns:

the original start line, or -1 if not available or not a multi-line comment

getParent

public GHPullRequest getParent()

Gets the pull request to which this review comment is associated.

Overrides:

getParent in class GHIssueComment

Returns:

the parent pull request

getPath

public String getPath()

Gets path.

Returns:

the path

getPosition

public int getPosition()

Gets position.

Returns:

the position, or -1 if not available

getPullRequestReviewId

public Long getPullRequestReviewId()

Gets The ID of the pull request review to which the comment belongs.

Returns:

Long the ID of the pull request review

getPullRequestUrl

public URL getPullRequestUrl()

Gets URL for the pull request that the review comment belongs to.

Returns:

URL the URL of the pull request

getReactions

public GHPullRequestReviewCommentReactions getReactions()

Gets the Reaction Rollup

Returns:

GHPullRequestReviewCommentReactions the reaction rollup

getSide

public GHPullRequestReviewComment.Side getSide()

Gets The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment.

This field is not available on GHPullRequestReview.ReviewComment objects returned by GHPullRequestReview.listReviewComments(). Use GHPullRequestReview.ReviewComment.readPullRequestReviewComment() or GHPullRequest.listReviewComments() to obtain this value.

Returns:

GHPullRequestReviewComment.Side the side of the diff to which the comment applies, or GHPullRequestReviewComment.Side.UNKNOWN if not available

getStartLine

public int getStartLine()

Gets The first line of the range for a multi-line comment.

This field is not available on GHPullRequestReview.ReviewComment objects returned by GHPullRequestReview.listReviewComments(). Use GHPullRequestReview.ReviewComment.readPullRequestReviewComment() or GHPullRequest.listReviewComments() to obtain this value.

Returns:

the start line, or -1 if not available or not a multi-line comment

getStartSide

public GHPullRequestReviewComment.Side getStartSide()

Gets The side of the first line of the range for a multi-line comment.

This field is not available on GHPullRequestReview.ReviewComment objects returned by GHPullRequestReview.listReviewComments(). Use GHPullRequestReview.ReviewComment.readPullRequestReviewComment() or GHPullRequest.listReviewComments() to obtain this value.

Returns:

GHPullRequestReviewComment.Side the side of the first line, or GHPullRequestReviewComment.Side.UNKNOWN if not available

getUser

public GHUser getUser()
               throws IOException

Gets the user who posted this comment.

Overrides:

getUser in class GHIssueComment

Returns:

the user

Throws:

IOException - the io exception

listReactions

public PagedIterable<GHReaction> listReactions()

List reactions.

Specified by:

listReactions in interface Reactable

Overrides:

listReactions in class GHIssueComment

Returns:

the paged iterable

refresh

public void refresh()
             throws IOException

Refreshes this comment by fetching the full data from the API.

This is useful when the comment was obtained via GHPullRequestReview.listReviewComments(), which uses a GitHub API endpoint that does not return all fields. After calling this method, fields like getLine(), getOriginalLine(), getSide(), etc. will return their actual values.

Specified by:

refresh in interface Refreshable

Throws:

IOException - if an I/O error occurs

See Also:

• GHPullRequest.listReviewComments()

reply

public GHPullRequestReviewComment reply(String body)
                                 throws IOException

Create a new comment that replies to this comment.

Parameters:

body - the body

Returns:

the gh pull request review comment

Throws:

IOException - the io exception

update

public void update(String body)
            throws IOException

Updates the comment.

Overrides:

update in class GHIssueComment

Parameters:

body - the body

Throws:

IOException - the io exception

getApiRoute

protected String getApiRoute()

Gets api route.

Returns:

the api route

getApiRoute

protected String getApiRoute(boolean includePullNumber)

Gets api route.

Parameters:

includePullNumber - if true, includes the owning pull request's number in the route.

Returns:

the api route