com.jcabi.github

Interface PullComments

@Immutable
public interface PullComments

Github pull comments.

Since:

0.8

Version:

$Id$

Author:

Andres Candal (andres.candal@rollasolution.com)

See Also:

Review Comments API

Method Summary

Methods

Modifier and Type	Method and Description
PullComment	get(int number) Get specific pull comment by number.
Iterable<PullComment>	iterate(int number, Map<String,String> params) Iterate all pull comments for a pull request.
Iterable<PullComment>	iterate(Map<String,String> params) Iterate all pull comments for this repo.
PullComment	post(String body, String commit, String path, int position) Post a new pull comment.
Pull	pull() Pull we're in.
void	remove(int number) Removes a pull comment by ID.
PullComment	reply(String body, int comment) Create a new comment as a reply to an existing pull comment.

Method Detail

pull

@NotNull(message="pull is never NULL")
Pull pull()

Pull we're in.

Returns:

Pull

get

@NotNull(message="PullComment is never NULL")
PullComment get(int number)

Get specific pull comment by number.

Parameters:

number - Pull comment number

Returns:

Pull comment

See Also:

Get a single comment

iterate

@NotNull(message="iterable is never NULL")
Iterable<PullComment> iterate(@NotNull(message="map of params can\'t be NULL")
                                           Map<String,String> params)

Iterate all pull comments for this repo.

Parameters:

params - Iterating parameters, as specified by API

Returns:

Iterable of pull comments

See Also:

List comments in a repository

iterate

@NotNull(message="iterable is never NULL")
Iterable<PullComment> iterate(int number,
                                           @NotNull(message="map of params can\'t be NULL")
                                           Map<String,String> params)

Iterate all pull comments for a pull request.

Parameters:

number - Pull comment number

params - Iterating parameters, as specified by API

Returns:

Iterable of pull comments

See Also:

List comments on a pull request

post

@NotNull(message="PullComment is never NULL")
PullComment post(@NotNull(message="Comment body is never NULL")
                              String body,
                              @NotNull(message="commit ID is never NULL")
                              String commit,
                              @NotNull(message="path body is never NULL")
                              String path,
                              @NotNull(message="position is never NULL")
                              int position)
                 throws IOException

Post a new pull comment.

Parameters:

body - Body of it

commit - Commit ID (SHA) of it

path - Path of the file to comment on

position - Line index in the diff to comment on

Returns:

PullComment just created

Throws:

IOException - If there is any I/O problem

See Also:

Create a comment

Suppressed Checkstyle violations:

ParameterNumberCheck (7 lines)

reply

@NotNull(message="PullComment is never NULL")
PullComment reply(@NotNull(message="Comment body is never NULL")
                               String body,
                               @NotNull(message="comment ID is never NULL")
                               int comment)
                  throws IOException

Create a new comment as a reply to an existing pull comment.

Parameters:

body - Body of it

comment - Commit ID (SHA) of it

Returns:

PullComment just created

Throws:

IOException - If there is any I/O problem

See Also:

Create a comment

remove

void remove(int number)
            throws IOException

Removes a pull comment by ID.

Parameters:

number - The ID of the pull comment to delete.

Throws:

IOException - If there is any I/O problem.