com.jdroid.github.service

Class PullRequestService

java.lang.Object

com.jdroid.github.service.GitHubService

com.jdroid.github.service.PullRequestService

public class PullRequestService
extends GitHubService

Service class for creating, updating, getting, and listing pull requests as well as getting the commits associated with a pull request and the files modified by a pull request.

See Also:

GitHub Pull Requests API documentation, GitHub Pull Request comments API documentation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ISSUE
static java.lang.String	PR_BASE PR_BASE
static java.lang.String	PR_BODY PR_BODY
static java.lang.String	PR_HEAD PR_HEAD
static java.lang.String	PR_STATE PR_STATE
static java.lang.String	PR_TITLE PR_TITLE

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
PullRequestService() Create pull request service
PullRequestService(GitHubClient client) Create pull request service

Method Summary

Modifier and Type	Method and Description
PullRequest	closePullRequest(IRepositoryIdProvider repository, int number)
CommitComment	createComment(IRepositoryIdProvider repository, int id, CommitComment comment) Create comment on given pull request
protected PagedRequest<PullRequest>	createPagedRequest(IRepositoryIdProvider provider, java.lang.String state, java.lang.String head, java.lang.String base, int start, int size) Create paged request for fetching pull requests
PullRequest	createPullRequest(IRepositoryIdProvider repository, int issueId, java.lang.String head, java.lang.String base) Create pull request by attaching branch information to an existing issue
PullRequest	createPullRequest(IRepositoryIdProvider repository, java.lang.String title, java.lang.String body, java.lang.String head, java.lang.String base) Create pull request
void	deleteComment(IRepositoryIdProvider repository, long commentId) Delete commit comment with given id
CommitComment	editComment(IRepositoryIdProvider repository, CommitComment comment) Edit pull request comment
PullRequest	editPullRequest(IRepositoryIdProvider repository, int number, java.lang.String title, java.lang.String body, java.lang.String state, java.lang.String base) Edit pull request
CommitComment	getComment(IRepositoryIdProvider repository, long commentId) Get commit comment with given id
java.util.List<CommitComment>	getComments(IRepositoryIdProvider repository, int id) Get all comments on commits in given pull request
java.util.List<RepositoryCommit>	getCommits(IRepositoryIdProvider repository, int id) Get all commits associated with given pull request id
java.util.List<CommitFile>	getFiles(IRepositoryIdProvider repository, int id) Get all changed files associated with given pull request id
PullRequest	getPullRequest(IRepositoryIdProvider repository, int id) Create request for single pull request
PullRequest	getPullRequest(IRepositoryIdProvider repository, java.lang.String state, java.lang.String head, java.lang.String base) Create request for single pull request
java.util.List<PullRequest>	getPullRequests(IRepositoryIdProvider repository, java.lang.String state) Get pull requests from repository matching state
boolean	isMerged(IRepositoryIdProvider repository, int id) Is the given pull request id merged?
MergeStatus	merge(IRepositoryIdProvider repository, int number, java.lang.String commitMessage) Merge given pull request
PageIterator<CommitComment>	pageComments(IRepositoryIdProvider repository, int id) Page pull request commit comments
PageIterator<CommitComment>	pageComments(IRepositoryIdProvider repository, int id, int size) Page pull request commit comments
PageIterator<CommitComment>	pageComments(IRepositoryIdProvider repository, int id, int start, int size) Page pull request commit comments
PageIterator<PullRequest>	pagePullRequests(IRepositoryIdProvider repository, java.lang.String state, java.lang.String head, java.lang.String base) Page pull requests with given state
PageIterator<PullRequest>	pagePullRequests(IRepositoryIdProvider repository, java.lang.String state, java.lang.String head, java.lang.String base, int size) Page pull requests with given state
PageIterator<PullRequest>	pagePullRequests(IRepositoryIdProvider repository, java.lang.String state, java.lang.String head, java.lang.String base, int start, int size) Page pull requests with given state
CommitComment	replyToComment(IRepositoryIdProvider repository, int pullRequestId, int commentId, java.lang.String body) Reply to given comment

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

Field Detail

PR_TITLE

public static final java.lang.String PR_TITLE

PR_TITLE

See Also:

Constant Field Values

PR_BODY

public static final java.lang.String PR_BODY

PR_BODY

See Also:

Constant Field Values

PR_BASE

public static final java.lang.String PR_BASE

PR_BASE

See Also:

Constant Field Values

PR_HEAD

public static final java.lang.String PR_HEAD

PR_HEAD

See Also:

Constant Field Values

PR_STATE

public static final java.lang.String PR_STATE

PR_STATE

See Also:

Constant Field Values

ISSUE

public static final java.lang.String ISSUE

See Also:

Constant Field Values

Constructor Detail

PullRequestService

public PullRequestService()

Create pull request service

PullRequestService

public PullRequestService(GitHubClient client)

Create pull request service

Parameters:

client -

Method Detail

getPullRequest

public PullRequest getPullRequest(IRepositoryIdProvider repository,
                                  int id)
                           throws java.io.IOException

Create request for single pull request

Parameters:

repository -

id -

Returns:

request

Throws:

java.io.IOException

getPullRequest

public PullRequest getPullRequest(IRepositoryIdProvider repository,
                                  java.lang.String state,
                                  java.lang.String head,
                                  java.lang.String base)
                           throws java.io.IOException

Create request for single pull request

Parameters:

repository -

state -

head -

base -

Returns:

request

Throws:

java.io.IOException

createPagedRequest

protected PagedRequest<PullRequest> createPagedRequest(IRepositoryIdProvider provider,
                                                       java.lang.String state,
                                                       java.lang.String head,
                                                       java.lang.String base,
                                                       int start,
                                                       int size)

Create paged request for fetching pull requests

Parameters:

provider -

state -

start -

size -

Returns:

paged request

getPullRequests

public java.util.List<PullRequest> getPullRequests(IRepositoryIdProvider repository,
                                                   java.lang.String state)
                                            throws java.io.IOException

Get pull requests from repository matching state

Parameters:

repository -

state -

Returns:

list of pull requests

Throws:

java.io.IOException

pagePullRequests

public PageIterator<PullRequest> pagePullRequests(IRepositoryIdProvider repository,
                                                  java.lang.String state,
                                                  java.lang.String head,
                                                  java.lang.String base)

Page pull requests with given state

Parameters:

repository -

state -

Returns:

iterator over pages of pull requests

pagePullRequests

public PageIterator<PullRequest> pagePullRequests(IRepositoryIdProvider repository,
                                                  java.lang.String state,
                                                  java.lang.String head,
                                                  java.lang.String base,
                                                  int size)

Page pull requests with given state

Parameters:

repository -

state -

size -

Returns:

iterator over pages of pull requests

pagePullRequests

public PageIterator<PullRequest> pagePullRequests(IRepositoryIdProvider repository,
                                                  java.lang.String state,
                                                  java.lang.String head,
                                                  java.lang.String base,
                                                  int start,
                                                  int size)

Page pull requests with given state

Parameters:

repository -

state -

start -

size -

Returns:

iterator over pages of pull requests

createPullRequest

public PullRequest createPullRequest(IRepositoryIdProvider repository,
                                     java.lang.String title,
                                     java.lang.String body,
                                     java.lang.String head,
                                     java.lang.String base)
                              throws java.io.IOException

Create pull request

Parameters:

repository -

Returns:

created pull request

Throws:

java.io.IOException

createPullRequest

public PullRequest createPullRequest(IRepositoryIdProvider repository,
                                     int issueId,
                                     java.lang.String head,
                                     java.lang.String base)
                              throws java.io.IOException

Create pull request by attaching branch information to an existing issue

Parameters:

repository -

issueId -

head -

base -

Returns:

created pull request

Throws:

java.io.IOException

editPullRequest

public PullRequest editPullRequest(IRepositoryIdProvider repository,
                                   int number,
                                   java.lang.String title,
                                   java.lang.String body,
                                   java.lang.String state,
                                   java.lang.String base)
                            throws java.io.IOException

Edit pull request

Parameters:

repository -

Returns:

edited pull request

Throws:

java.io.IOException

closePullRequest

public PullRequest closePullRequest(IRepositoryIdProvider repository,
                                    int number)
                             throws java.io.IOException

Throws:

java.io.IOException

getCommits

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

Get all commits associated with given pull request id

Parameters:

repository -

id -

Returns:

list of commits

Throws:

java.io.IOException

getFiles

public java.util.List<CommitFile> getFiles(IRepositoryIdProvider repository,
                                           int id)
                                    throws java.io.IOException

Get all changed files associated with given pull request id

Parameters:

repository -

id -

Returns:

list of commit files

Throws:

java.io.IOException

isMerged

public boolean isMerged(IRepositoryIdProvider repository,
                        int id)
                 throws java.io.IOException

Is the given pull request id merged?

Parameters:

repository -

id -

Returns:

true if merge, false otherwise

Throws:

java.io.IOException

merge

public MergeStatus merge(IRepositoryIdProvider repository,
                         int number,
                         java.lang.String commitMessage)
                  throws java.io.IOException

Merge given pull request

Parameters:

repository -

number -

commitMessage -

Returns:

status of merge

Throws:

java.io.IOException

getComments

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

Get all comments on commits in given pull request

Parameters:

repository -

id -

Returns:

non-null list of comments

Throws:

java.io.IOException

pageComments

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

Page pull request commit comments

Parameters:

repository -

id -

Returns:

iterator over pages of commit comments

pageComments

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

Page pull request commit comments

Parameters:

repository -

id -

size -

Returns:

iterator over pages of commit comments

pageComments

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

Page pull request commit comments

Parameters:

repository -

id -

start -

size -

Returns:

iterator over pages of commit 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

createComment

public CommitComment createComment(IRepositoryIdProvider repository,
                                   int id,
                                   CommitComment comment)
                            throws java.io.IOException

Create comment on given pull request

Parameters:

repository -

id -

comment -

Returns:

created commit comment

Throws:

java.io.IOException

replyToComment

public CommitComment replyToComment(IRepositoryIdProvider repository,
                                    int pullRequestId,
                                    int commentId,
                                    java.lang.String body)
                             throws java.io.IOException

Reply to given comment

Parameters:

repository -

pullRequestId -

commentId -

body -

Returns:

created comment

Throws:

java.io.IOException

editComment

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

Edit pull request 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

Parameters:

repository -

commentId -

Throws:

java.io.IOException