org.kohsuke.github

Class GHCommit

java.lang.Object

org.kohsuke.github.GHCommit

Direct Known Subclasses:

GHCompare.Commit

public class GHCommit
extends java.lang.Object

A commit in a repository.

Author:

Kohsuke Kawaguchi

See Also:

GHRepository.getCommit(String), GHCommitComment.getCommit()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GHCommit.File A file that was modified.
static class	GHCommit.GHAuthor Deprecated. Use GitUser instead.
static class	GHCommit.Parent
static class	GHCommit.ShortInfo Short summary of this commit.
static class	GHCommit.Stats

Constructor Summary

Constructors

Constructor and Description
GHCommit()

Method Summary

Modifier and Type	Method and Description
GHCommitComment	createComment(java.lang.String body)
GHCommitComment	createComment(java.lang.String body, java.lang.String path, java.lang.Integer line, java.lang.Integer position) Creates a commit comment.
GHUser	getAuthor()
java.util.Date	getAuthoredDate() Gets the date the change was authored on.
java.util.Date	getCommitDate() Gets the date the change was committed on.
GHCommit.ShortInfo	getCommitShortInfo()
GHUser	getCommitter()
java.util.List<GHCommit.File>	getFiles() List of files changed/added/removed in this commit.
java.net.URL	getHtmlUrl() URL of this commit like "https://github.com/kohsuke/sandbox-ant/commit/8ae38db0ea5837313ab5f39d43a6f73de3bd9000"
GHCommitStatus	getLastStatus() Gets the last status of this commit, which is what gets shown in the UI.
int	getLinesAdded() Number of lines added.
int	getLinesChanged() Number of lines added + removed.
int	getLinesDeleted() Number of lines removed.
GHRepository	getOwner() The repository that contains the commit.
java.util.List<GHCommit>	getParents() Resolves the parent commit objects and return them.
java.util.List<java.lang.String>	getParentSHA1s() Returns the SHA1 of parent commit objects.
java.lang.String	getSHA1() [0-9a-f]{40} SHA1 checksum.
PagedIterable<GHCommitComment>	listComments() Lists up all the commit comments in this repository.
PagedIterable<GHCommitStatus>	listStatuses() Gets the status of this commit, newer ones first.

Methods inherited from class java.lang.Object

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

Constructor Detail

GHCommit

public GHCommit()

Method Detail

getCommitShortInfo

public GHCommit.ShortInfo getCommitShortInfo()
                                      throws java.io.IOException

Throws:

java.io.IOException

getOwner

public GHRepository getOwner()

The repository that contains the commit.

getLinesChanged

public int getLinesChanged()
                    throws java.io.IOException

Number of lines added + removed.

Throws:

java.io.IOException

getLinesAdded

public int getLinesAdded()
                  throws java.io.IOException

Number of lines added.

Throws:

java.io.IOException

getLinesDeleted

public int getLinesDeleted()
                    throws java.io.IOException

Number of lines removed.

Throws:

java.io.IOException

getHtmlUrl

public java.net.URL getHtmlUrl()

URL of this commit like "https://github.com/kohsuke/sandbox-ant/commit/8ae38db0ea5837313ab5f39d43a6f73de3bd9000"

getSHA1

public java.lang.String getSHA1()

[0-9a-f]{40} SHA1 checksum.

getFiles

public java.util.List<GHCommit.File> getFiles()
                                       throws java.io.IOException

List of files changed/added/removed in this commit.

Returns:

Can be empty but never null.

Throws:

java.io.IOException

getParentSHA1s

public java.util.List<java.lang.String> getParentSHA1s()

Returns the SHA1 of parent commit objects.

getParents

public java.util.List<GHCommit> getParents()
                                    throws java.io.IOException

Resolves the parent commit objects and return them.

Throws:

java.io.IOException

getAuthor

public GHUser getAuthor()
                 throws java.io.IOException

Throws:

java.io.IOException

getAuthoredDate

public java.util.Date getAuthoredDate()
                               throws java.io.IOException

Gets the date the change was authored on.

Returns:

the date the change was authored on.

Throws:

java.io.IOException - if the information was not already fetched and an attempt at fetching the information failed.

getCommitter

public GHUser getCommitter()
                    throws java.io.IOException

Throws:

java.io.IOException

getCommitDate

public java.util.Date getCommitDate()
                             throws java.io.IOException

Gets the date the change was committed on.

Returns:

the date the change was committed on.

Throws:

java.io.IOException - if the information was not already fetched and an attempt at fetching the information failed.

listComments

public PagedIterable<GHCommitComment> listComments()

Lists up all the commit comments in this repository.

createComment

public GHCommitComment createComment(java.lang.String body,
                                     java.lang.String path,
                                     java.lang.Integer line,
                                     java.lang.Integer position)
                              throws java.io.IOException

Creates a commit comment. I'm not sure how path/line/position parameters interact with each other.

Throws:

java.io.IOException

createComment

public GHCommitComment createComment(java.lang.String body)
                              throws java.io.IOException

Throws:

java.io.IOException

listStatuses

public PagedIterable<GHCommitStatus> listStatuses()
                                           throws java.io.IOException

Gets the status of this commit, newer ones first.

Throws:

java.io.IOException

getLastStatus

public GHCommitStatus getLastStatus()
                             throws java.io.IOException

Gets the last status of this commit, which is what gets shown in the UI.

Throws:

java.io.IOException