com.jcabi.github

Interface Pull

All Superinterfaces:

Comparable<Pull>, JsonPatchable, JsonReadable

All Known Implementing Classes:

Pull.Smart

@Immutable
public interface Pull
extends Comparable<Pull>, JsonReadable, JsonPatchable

Github pull request.

Since:

0.3

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Pull Request API

Suppressed Checkstyle violations:

MultipleStringLiterals (500 lines)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Pull.Smart Smart pull request with extra features.

Method Summary

Methods

Modifier and Type	Method and Description
PullComments	comments() Get Pull Comments.
Iterable<Commit>	commits() Get all commits of the pull request.
Iterable<javax.json.JsonObject>	files() List all files of the pull request.
void	merge(String msg) Merge it.
int	number() Get its number.
Repo	repo() Pull we're in.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.jcabi.github.JsonReadable

json

Methods inherited from interface com.jcabi.github.JsonPatchable

patch

Method Detail

repo

@NotNull(message="repository is never NULL")
Repo repo()

Pull we're in.

Returns:

Repo

number

int number()

Get its number.

Returns:

Pull request number

commits

@NotNull(message="commits are never NULL")
Iterable<Commit> commits()
                         throws IOException

Get all commits of the pull request.

Returns:

Commits

Throws:

IOException - If there is any I/O problem

See Also:

List Commits on a Pull Request

files

@NotNull(message="iterable of files is never NULL")
Iterable<javax.json.JsonObject> files()
                                      throws IOException

List all files of the pull request.

Returns:

Files

Throws:

IOException - If there is any I/O problem

See Also:

List Pull Request Files

merge

void merge(@NotNull(message="message can\'t be NULL")
         String msg)
           throws IOException

Merge it.

Parameters:

msg - Commit message

Throws:

IOException - If there is any I/O problem

See Also:

Merge a Pull Request

comments

@NotNull(message="PullComments is never NULL")
PullComments comments()
                      throws IOException

Get Pull Comments.

Returns:

Comments.

Throws:

IOException - If there is any I/O problem

See Also:

Link Relations - Review Comments