com.jcabi.github

Class RtStatuses

java.lang.Object

com.jcabi.github.RtStatuses

All Implemented Interfaces:

JsonReadable, Statuses

public class RtStatuses
extends Object
implements Statuses

Github statuses for a given commit.

Since:

0.23

Version:

$Id$

Author:

Marcin Cylke (maracin.cylke+github@gmail.com)

Suppressed Checkstyle violations:

MultipleStringLiteralsCheck (500 lines)

Nested Class Summary

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

Statuses.Smart

Method Summary

Methods

Modifier and Type	Method and Description
Commit	commit() Get commit object.
Status	create(Status status) Create new status for a commit.
javax.json.JsonObject	json() JSON object for this request.
Iterable<Statuses>	list(String ref) Get all status messages for current commit.
String	toString() Generate string representation.

Methods inherited from class java.lang.Object

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

Method Detail

toString

@NotNull(message="toString is never NULL")
public final String toString()

Generate string representation.

Overrides:

toString in class Object

Returns:

String representation

commit

@NotNull(message="Commit can\'t be NULL")
public final Commit commit()

Get commit object.

Specified by:

commit in interface Statuses

Returns:

Commit object

create

public final Status create(@NotNull(message="status can\'t be NULL")
            Status status)
                    throws IOException

Create new status for a commit.

Specified by:

create in interface Statuses

Parameters:

status - Add this status

Returns:

Returned status

Throws:

IOException - In case of any I/O problems

list

@NotNull(message="list of statuses can\'t be NULL")
public final Iterable<Statuses> list(@NotNull(message="ref can\'t be NULL")
                                     String ref)

Get all status messages for current commit.

Specified by:

list in interface Statuses

Parameters:

ref - It can be a SHA, a branch name, or a tag name.

Returns:

Full list of statuses for this commit.

json

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

JSON object for this request.

Specified by:

json in interface JsonReadable

Returns:

Json object

Throws:

IOException - In case of I/O problems