com.jcabi.github

Interface Statuses

All Superinterfaces:

JsonReadable

All Known Implementing Classes:

RtStatuses, Statuses.Smart

@Immutable
public interface Statuses
extends JsonReadable

Github status.

The status exposes all available properties through its json() method. However, it is recommended to use its "smart" decorator, which helps you to get access to all JSON properties, for example:

 URL url = new Status.Smart(status).url();

Since:

0.23

Version:

$Id$

Author:

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

See Also:

Repo statuses

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Statuses.Smart Smart commit.

Method Summary

Methods

Modifier and Type	Method and Description
Commit	commit() Associated commit.
Status	create(Status status) Create new status.
Iterable<Statuses>	list(String ref) List all statuses for a given ref.

Methods inherited from interface com.jcabi.github.JsonReadable

json

Method Detail

commit

@NotNull(message="commit is never NULL")
Commit commit()

Associated commit.

Returns:

Commit

create

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

Create new status.

Parameters:

status - Add this status

Returns:

The added status

Throws:

IOException - If there is any I/O problem

list

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

List all statuses for a given ref.

Parameters:

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

Returns:

List of statuses