com.jcabi.github

Class Pull.Smart

java.lang.Object

com.jcabi.github.Pull.Smart

All Implemented Interfaces:

JsonPatchable, JsonReadable, Pull, Comparable<Pull>

Enclosing interface:

Pull

@Immutable
@Loggable(value=1)
public static final class Pull.Smart
extends Object
implements Pull

Smart pull request with extra features.

Nested Class Summary

Nested classes/interfaces inherited from interface com.jcabi.github.Pull

Pull.Smart

Constructor Summary

Constructors

Constructor and Description
Pull.Smart(Pull pll) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
String	body() Get its title.
void	body(String text) Change its body.
Date	closedAt() When this pull request was closed.
PullComments	comments() Get Pull Comments.
int	commentsCount() Get comments count.
Iterable<Commit>	commits() Get all commits of the pull request.
int	compareTo(Pull obj)
Date	createdAt() When this pull request was created.
Iterable<javax.json.JsonObject>	files() List all files of the pull request.
URL	htmlUrl() Get its HTML URL.
boolean	isOpen() Is it open?
Issue	issue() Get an issue where the pull request is submitted.
javax.json.JsonObject	json() Describe it in a JSON object.
void	merge(String msg) Merge it.
Date	mergedAt() When this pull request was merged.
int	number() Get its number.
void	patch(javax.json.JsonObject json) Patch using this JSON object.
Repo	repo() Pull we're in.
String	state() Get its state.
void	state(String state) Change its state.
String	title() Get its body.
void	title(String text) Change its state.
Date	updatedAt() When this pull request was updated.
URL	url() Get its URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pull.Smart

public Pull.Smart(@NotNull(message="pll can\'t be NULL")
          Pull pll)

Public ctor.

Parameters:

pll - Pull request

Method Detail

isOpen

public boolean isOpen()
               throws IOException

Is it open?

Returns:

TRUE if it's open

Throws:

IOException - If there is any I/O problem

state

@NotNull(message="state is never NULL")
public String state()
             throws IOException

Get its state.

Returns:

State of pull request

Throws:

IOException - If there is any I/O problem

state

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

Change its state.

Parameters:

state - State of pull request

Throws:

IOException - If there is any I/O problem

title

@NotNull(message="title can\'t be NULL")
public String title()
             throws IOException

Get its body.

Returns:

Body of pull request

Throws:

IOException - If there is any I/O problem

title

public void title(@NotNull(message="text can\'t be NULL")
         String text)
           throws IOException

Change its state.

Parameters:

text - Text of pull request

Throws:

IOException - If there is any I/O problem

body

@NotNull(message="body is never NULL")
public String body()
            throws IOException

Get its title.

Returns:

Title of pull request

Throws:

IOException - If there is any I/O problem

body

public void body(@NotNull(message="text can\'t be NULL")
        String text)
          throws IOException

Change its body.

Parameters:

text - Body of pull request

Throws:

IOException - If there is any I/O problem

url

@NotNull(message="url is never NULL")
public URL url()
        throws IOException

Get its URL.

Returns:

URL of pull request

Throws:

IOException - If there is any I/O problem

htmlUrl

@NotNull(message="url is never NULL")
public URL htmlUrl()
            throws IOException

Get its HTML URL.

Returns:

URL of pull request

Throws:

IOException - If there is any I/O problem

createdAt

@NotNull(message="date shouldn\'t NULL")
public Date createdAt()
               throws IOException

When this pull request was created.

Returns:

Date of creation

Throws:

IOException - If there is any I/O problem

updatedAt

@NotNull(message="date is not NULL")
public Date updatedAt()
               throws IOException

When this pull request was updated.

Returns:

Date of update

Throws:

IOException - If there is any I/O problem

closedAt

@NotNull(message="date can\'t NULL")
public Date closedAt()
              throws IOException

When this pull request was closed.

Returns:

Date of closing

Throws:

IOException - If there is any I/O problem

mergedAt

@NotNull(message="date is never NULL")
public Date mergedAt()
              throws IOException

When this pull request was merged.

Returns:

Date of merging

Throws:

IOException - If there is any I/O problem

issue

@NotNull(message="issue is never NULL")
public Issue issue()

Get an issue where the pull request is submitted.

Returns:

Issue

commentsCount

public int commentsCount()
                  throws IOException

Get comments count.

Returns:

Count of comments

Throws:

IOException - If there is any I/O problem

Since:

0.8

repo

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

Description copied from interface: Pull

Pull we're in.

Specified by:

repo in interface Pull

Returns:

Repo

number

public int number()

Description copied from interface: Pull

Get its number.

Specified by:

number in interface Pull

Returns:

Pull request number

commits

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

Description copied from interface: Pull

Get all commits of the pull request.

Specified by:

commits in interface Pull

Returns:

Commits

Throws:

IOException - If there is any I/O problem

See Also:

List Commits on a Pull Request

files

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

Description copied from interface: Pull

List all files of the pull request.

Specified by:

files in interface Pull

Returns:

Files

Throws:

IOException - If there is any I/O problem

See Also:

List Pull Request Files

merge

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

Description copied from interface: Pull

Merge it.

Specified by:

merge in interface Pull

Parameters:

msg - Commit message

Throws:

IOException - If there is any I/O problem

See Also:

Merge a Pull Request

comments

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

Description copied from interface: Pull

Get Pull Comments.

Specified by:

comments in interface Pull

Returns:

Comments.

Throws:

IOException - If there is any I/O problem

See Also:

Link Relations - Review Comments

json

@NotNull(message="JSON is never NULL")
public javax.json.JsonObject json()
                           throws IOException

Description copied from interface: JsonReadable

Describe it in a JSON object.

Specified by:

json in interface JsonReadable

Returns:

JSON object

Throws:

IOException - If there is any I/O problem

patch

public void patch(@NotNull(message="json can\'t be NULL")
         javax.json.JsonObject json)
           throws IOException

Description copied from interface: JsonPatchable

Patch using this JSON object.

Specified by:

patch in interface JsonPatchable

Parameters:

json - JSON object

Throws:

IOException - If there is any I/O problem

compareTo

public int compareTo(@NotNull(message="obj can\'t be NULL")
            Pull obj)

Specified by:

compareTo in interface Comparable<Pull>