Module org.kohsuke.github.api

Package org.kohsuke.github

Class GHPullRequestReviewCommentBuilder

java.lang.Object

org.kohsuke.github.GHPullRequestReviewCommentBuilder

public class GHPullRequestReviewCommentBuilder
extends Object

Builds up a creation of new GHPullRequestReviewComment.

See Also:

• GHPullRequest.createReviewComment()

Method Summary

Modifier and Type	Method	Description
GHPullRequestReviewCommentBuilder	body(String body)	The text of the pull request review comment.
GHPullRequestReviewCommentBuilder	commitId(String commitId)	The SHA of the commit that needs a review.
GHPullRequestReviewComment	create()	Create gh pull request review comment.
GHPullRequestReviewCommentBuilder	line(int line)	A single line of the blob in the pull request diff that the comment applies to.
GHPullRequestReviewCommentBuilder	lines(int startLine, int endLine)	The range of lines in the pull request diff that this comment applies to.
GHPullRequestReviewCommentBuilder	path(String path)	The relative path to the file that necessitates a comment.
GHPullRequestReviewCommentBuilder	side(GHPullRequestReviewComment.Side side)	The side of the diff in the pull request that the comment applies to.
GHPullRequestReviewCommentBuilder	sides(GHPullRequestReviewComment.Side startSide, GHPullRequestReviewComment.Side endSide)	The sides of the diff in the pull request that the comment applies to.

Methods inherited from class java.lang.Object

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

Method Details

commitId

public GHPullRequestReviewCommentBuilder commitId(String commitId)

The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

Parameters:

commitId - the commit id

Returns:

the gh pull request review comment builder

body

public GHPullRequestReviewCommentBuilder body(String body)

The text of the pull request review comment.

Parameters:

body - the body

Returns:

the gh pull request review comment builder

path

public GHPullRequestReviewCommentBuilder path(String path)

The relative path to the file that necessitates a comment.

Parameters:

path - the path

Returns:

the gh pull request review comment builder

line

public GHPullRequestReviewCommentBuilder line(int line)

A single line of the blob in the pull request diff that the comment applies to.

line(int) and lines(int, int) will overwrite each other's values.

Parameters:

line - the line number

Returns:

the gh pull request review comment builder

lines

public GHPullRequestReviewCommentBuilder lines(int startLine,
 int endLine)

The range of lines in the pull request diff that this comment applies to.

line(int) and lines(int, int) will overwrite each other's values.

Parameters:

startLine - the start line number of the comment

endLine - the end line number of the comment

Returns:

the gh pull request review comment builder

side

public GHPullRequestReviewCommentBuilder side(GHPullRequestReviewComment.Side side)

The side of the diff in the pull request that the comment applies to.

side(GHPullRequestReviewComment.Side) and sides(GHPullRequestReviewComment.Side, GHPullRequestReviewComment.Side) will overwrite each other's values.

Parameters:

side - side of the diff to which the comment applies

Returns:

the gh pull request review comment builder

sides

public GHPullRequestReviewCommentBuilder sides(GHPullRequestReviewComment.Side startSide,
 GHPullRequestReviewComment.Side endSide)

The sides of the diff in the pull request that the comment applies to.

side(GHPullRequestReviewComment.Side) and sides(GHPullRequestReviewComment.Side, GHPullRequestReviewComment.Side) will overwrite each other's values.

Parameters:

startSide - side of the diff to which the start of the comment applies

endSide - side of the diff to which the end of the comment applies

Returns:

the gh pull request review comment builder

create

public GHPullRequestReviewComment create()
                                  throws IOException

Create gh pull request review comment.

Returns:

the gh pull request review comment builder

Throws:

IOException - the io exception