com.jdroid.github.service

Class CommitService

java.lang.Object

com.jdroid.github.service.GitHubService

com.jdroid.github.service.CommitService

public class CommitService
extends GitHubService

Service for interacting with repository commits

See Also:

GitHub commit API documentation

Field Summary

Fields inherited from class com.jdroid.github.service.GitHubService

ACCEPT_FULL, ACCEPT_HTML, ACCEPT_PREVIEW_DRAX, ACCEPT_PREVIEW_IRONMAN, ACCEPT_PREVIEW_LOKI, ACCEPT_RAW, ACCEPT_TEXT, client

Constructor Summary

Constructors

Constructor and Description
CommitService() Create commit service
CommitService(GitHubClient client) Create commit service

Method Summary

Modifier and Type	Method and Description
CommitComment	addComment(IRepositoryIdProvider repository, java.lang.String sha, CommitComment comment) Add comment to given commit
RepositoryCommitCompare	compare(IRepositoryIdProvider repository, java.lang.String base, java.lang.String head) Compare base and head commits
CommitStatus	createStatus(IRepositoryIdProvider repository, java.lang.String sha, CommitStatus status) Create status for commit SHA-1
void	deleteComment(IRepositoryIdProvider repository, long commentId) Delete commit comment with given id from given repository
CommitComment	editComment(IRepositoryIdProvider repository, CommitComment comment) Edit given comment
CommitComment	getComment(IRepositoryIdProvider repository, long commentId) Get commit comment with given id
java.util.List<CommitComment>	getComments(IRepositoryIdProvider repository) Get all comments on all commits in the given repository
java.util.List<CommitComment>	getComments(IRepositoryIdProvider repository, java.lang.String sha) Get all comments on commit with given SHA-1
RepositoryCommit	getCommit(IRepositoryIdProvider repository, java.lang.String sha) Get commit with given SHA-1 from given repository
java.util.List<RepositoryCommit>	getCommits(IRepositoryIdProvider repository) Get all commits in given repository
java.util.List<RepositoryCommit>	getCommits(IRepositoryIdProvider repository, java.lang.String sha, java.lang.String path) Get all commits in given repository beginning at an optional commit SHA-1 and affecting an optional path.
java.util.List<CommitStatus>	getStatuses(IRepositoryIdProvider repository, java.lang.String sha) Get statuses for commit SHA-1
PageIterator<CommitComment>	pageComments(IRepositoryIdProvider repository) Page all comments on all commits in the given repository
PageIterator<CommitComment>	pageComments(IRepositoryIdProvider repository, int size) Page all comments on all commits in the given repository
PageIterator<CommitComment>	pageComments(IRepositoryIdProvider repository, int start, int size) Page all comments on all commits in the given repository
PageIterator<CommitComment>	pageComments(IRepositoryIdProvider repository, java.lang.String sha) Page comments on commit with given SHA-1
PageIterator<CommitComment>	pageComments(IRepositoryIdProvider repository, java.lang.String sha, int size) Page comments on commit with given SHA-1
PageIterator<CommitComment>	pageComments(IRepositoryIdProvider repository, java.lang.String sha, int start, int size) Page comments on commit with given SHA-1
PageIterator<RepositoryCommit>	pageCommits(IRepositoryIdProvider repository) Page commits in given repository
PageIterator<RepositoryCommit>	pageCommits(IRepositoryIdProvider repository, int size) Page commits in given repository
PageIterator<RepositoryCommit>	pageCommits(IRepositoryIdProvider repository, java.lang.String sha, java.lang.String path) Page commits in given repository
PageIterator<RepositoryCommit>	pageCommits(IRepositoryIdProvider repository, java.lang.String sha, java.lang.String path, int size) Page commits in given repository

Methods inherited from class com.jdroid.github.service.GitHubService

check, createPagedRequest, createPagedRequest, createPageIterator, createRequest, getAll, getAll, getClient, getId, verifyRepository

Methods inherited from class java.lang.Object

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

Constructor Detail

CommitService

public CommitService()

Create commit service

CommitService

public CommitService(GitHubClient client)

Create commit service

Parameters:

client -

Method Detail

getCommits

public java.util.List<RepositoryCommit> getCommits(IRepositoryIdProvider repository)
                                            throws java.io.IOException

Get all commits in given repository

Parameters:

repository -

Returns:

non-null but possibly empty list of repository commits

Throws:

java.io.IOException

getCommits

public java.util.List<RepositoryCommit> getCommits(IRepositoryIdProvider repository,
                                                   java.lang.String sha,
                                                   java.lang.String path)
                                            throws java.io.IOException

Get all commits in given repository beginning at an optional commit SHA-1 and affecting an optional path.

Parameters:

repository -

sha -

path -

Returns:

non-null but possibly empty list of repository commits

Throws:

java.io.IOException

pageCommits

public PageIterator<RepositoryCommit> pageCommits(IRepositoryIdProvider repository)

Page commits in given repository

Parameters:

repository -

Returns:

page iterator

pageCommits

public PageIterator<RepositoryCommit> pageCommits(IRepositoryIdProvider repository,
                                                  int size)

Page commits in given repository

Parameters:

repository -

size -

Returns:

page iterator

pageCommits

public PageIterator<RepositoryCommit> pageCommits(IRepositoryIdProvider repository,
                                                  java.lang.String sha,
                                                  java.lang.String path)

Page commits in given repository

Parameters:

repository -

sha -

path -

Returns:

page iterator

pageCommits

public PageIterator<RepositoryCommit> pageCommits(IRepositoryIdProvider repository,
                                                  java.lang.String sha,
                                                  java.lang.String path,
                                                  int size)

Page commits in given repository

Parameters:

repository -

sha -

path -

size -

Returns:

page iterator

getCommit

public RepositoryCommit getCommit(IRepositoryIdProvider repository,
                                  java.lang.String sha)
                           throws java.io.IOException

Get commit with given SHA-1 from given repository

Parameters:

repository -

sha -

Returns:

repository commit

Throws:

java.io.IOException

getComments

public java.util.List<CommitComment> getComments(IRepositoryIdProvider repository,
                                                 java.lang.String sha)
                                          throws java.io.IOException

Get all comments on commit with given SHA-1

Parameters:

repository -

sha -

Returns:

non-null but possibly empty list of commits

Throws:

java.io.IOException

pageComments

public PageIterator<CommitComment> pageComments(IRepositoryIdProvider repository,
                                                java.lang.String sha)

Page comments on commit with given SHA-1

Parameters:

repository -

sha -

Returns:

page iterator over comments

pageComments

public PageIterator<CommitComment> pageComments(IRepositoryIdProvider repository,
                                                java.lang.String sha,
                                                int size)

Page comments on commit with given SHA-1

Parameters:

repository -

sha -

size -

Returns:

page iterator over comments

pageComments

public PageIterator<CommitComment> pageComments(IRepositoryIdProvider repository,
                                                java.lang.String sha,
                                                int start,
                                                int size)

Page comments on commit with given SHA-1

Parameters:

repository -

sha -

start -

size -

Returns:

page iterator over comments

getComment

public CommitComment getComment(IRepositoryIdProvider repository,
                                long commentId)
                         throws java.io.IOException

Get commit comment with given id

Parameters:

repository -

commentId -

Returns:

commit comment

Throws:

java.io.IOException

addComment

public CommitComment addComment(IRepositoryIdProvider repository,
                                java.lang.String sha,
                                CommitComment comment)
                         throws java.io.IOException

Add comment to given commit

Parameters:

repository -

sha -

comment -

Returns:

created comment

Throws:

java.io.IOException

editComment

public CommitComment editComment(IRepositoryIdProvider repository,
                                 CommitComment comment)
                          throws java.io.IOException

Edit given comment

Parameters:

repository -

comment -

Returns:

edited comment

Throws:

java.io.IOException

deleteComment

public void deleteComment(IRepositoryIdProvider repository,
                          long commentId)
                   throws java.io.IOException

Delete commit comment with given id from given repository

Parameters:

repository -

commentId -

Throws:

java.io.IOException

compare

public RepositoryCommitCompare compare(IRepositoryIdProvider repository,
                                       java.lang.String base,
                                       java.lang.String head)
                                throws java.io.IOException

Compare base and head commits

Parameters:

repository -

base -

head -

Returns:

commit compare

Throws:

java.io.IOException

getStatuses

public java.util.List<CommitStatus> getStatuses(IRepositoryIdProvider repository,
                                                java.lang.String sha)
                                         throws java.io.IOException

Get statuses for commit SHA-1

Parameters:

repository -

sha -

Returns:

list of statuses

Throws:

java.io.IOException

createStatus

public CommitStatus createStatus(IRepositoryIdProvider repository,
                                 java.lang.String sha,
                                 CommitStatus status)
                          throws java.io.IOException

Create status for commit SHA-1

Parameters:

repository -

sha -

status -

Returns:

created status

Throws:

java.io.IOException

getComments

public java.util.List<CommitComment> getComments(IRepositoryIdProvider repository)
                                          throws java.io.IOException

Get all comments on all commits in the given repository

Parameters:

repository -

Returns:

non-null but possibly empty list of commits

Throws:

java.io.IOException

pageComments

public PageIterator<CommitComment> pageComments(IRepositoryIdProvider repository)

Page all comments on all commits in the given repository

Parameters:

repository -

Returns:

page iterator over comments

pageComments

public PageIterator<CommitComment> pageComments(IRepositoryIdProvider repository,
                                                int size)

Page all comments on all commits in the given repository

Parameters:

repository -

size -

Returns:

page iterator over comments

pageComments

public PageIterator<CommitComment> pageComments(IRepositoryIdProvider repository,
                                                int start,
                                                int size)

Page all comments on all commits in the given repository

Parameters:

repository -

start -

size -

Returns:

page iterator over comments