Package org.kohsuke.github

Class GHCommitComment

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHCommitComment

All Implemented Interfaces:

Reactable

public class GHCommitComment
extends GHObject
implements Reactable

A comment attached to a commit (or a specific line in a specific file of a commit.)

Author:

Kohsuke Kawaguchi

See Also:

GHRepository#listCommitComments(), GHCommit#listComments(), GHCommit#createComment(String, String, Integer, Integer)

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

responseHeaderFields

Constructor Summary

Constructors

Constructor	Description
GHCommitComment()

Method Summary

Modifier and Type	Method	Description
GHReaction	createReaction(ReactionContent content)	Creates the reaction.
void	delete()	Deletes this comment.
void	deleteReaction(GHReaction reaction)	Delete reaction.
String	getBody()	Commit comment in the GitHub flavored markdown format.
GHCommit	getCommit()	Gets the commit to which this comment is associated with.
URL	getHtmlUrl()	URL like 'https://github.com/kohsuke/sandbox-ant/commit/8ae38db0ea5837313ab5f39d43a6f73de3bd9000#commitcomment-1252827' to show this commit comment in a browser.
int	getLine()	A commit comment can be on a specific line of a specific file, if so, this field points to the line number in the file.
GHRepository	getOwner()	Gets owner.
String	getPath()	A commit comment can be on a specific line of a specific file, if so, this field points to a file.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
String	getSHA1()	Gets sha 1.
GHUser	getUser()	Gets the user who put this comment.
PagedIterable<GHReaction>	listReactions()	List reactions.
void	update(String body)	Updates the body of the commit message.

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

Constructor Detail

GHCommitComment

public GHCommitComment()

Method Detail

getOwner

public GHRepository getOwner()

Gets owner.

Returns:

the owner

getHtmlUrl

public URL getHtmlUrl()

URL like 'https://github.com/kohsuke/sandbox-ant/commit/8ae38db0ea5837313ab5f39d43a6f73de3bd9000#commitcomment-1252827' to show this commit comment in a browser.

Specified by:

getHtmlUrl in class GHObject

Returns:

the html url

getSHA1

public String getSHA1()

Gets sha 1.

Returns:

the sha 1

getBody

public String getBody()

Commit comment in the GitHub flavored markdown format.

Returns:

the body

getPath

public String getPath()

A commit comment can be on a specific line of a specific file, if so, this field points to a file. Otherwise null.

Returns:

the path

getLine

public int getLine()

A commit comment can be on a specific line of a specific file, if so, this field points to the line number in the file. Otherwise -1.

Returns:

the line

getUser

public GHUser getUser()
               throws IOException

Gets the user who put this comment.

Returns:

the user

Throws:

IOException - the io exception

getCommit

public GHCommit getCommit()
                   throws IOException

Gets the commit to which this comment is associated with.

Returns:

the commit

Throws:

IOException - the io exception

update

public void update(String body)
            throws IOException

Updates the body of the commit message.

Parameters:

body - the body

Throws:

IOException - the io exception

createReaction

@Preview(SQUIRREL_GIRL)
public GHReaction createReaction(ReactionContent content)
                          throws IOException

Creates the reaction.

Specified by:

createReaction in interface Reactable

Parameters:

content - the content

Returns:

the GH reaction

Throws:

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

deleteReaction

public void deleteReaction(GHReaction reaction)
                    throws IOException

Delete reaction.

Specified by:

deleteReaction in interface Reactable

Parameters:

reaction - the reaction

Throws:

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

listReactions

@Preview(SQUIRREL_GIRL)
public PagedIterable<GHReaction> listReactions()

List reactions.

Specified by:

listReactions in interface Reactable

Returns:

the paged iterable

delete

public void delete()
            throws IOException

Deletes this comment.

Throws:

IOException - the io exception

getRoot

@Deprecated
public GitHub getRoot()

Deprecated.

For access to the GitHub instance, use a local copy instead of pulling it out of objects.

Get the root GitHub instance for this object.

Returns:

the root GitHub instance