Package com.jcabi.github

Interface Statuses

All Superinterfaces:

JsonReadable

All Known Implementing Classes:

RtStatuses

@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

See Also:

• Repo statuses

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Statuses.StatusCreate	Data to use when creating a new GitHub commit status.

Method Summary

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

Methods inherited from interface com.jcabi.github.JsonReadable

json

Method Details

commit

Commit commit()

Associated commit.

Returns:

Commit

create

Status create(Statuses.StatusCreate status)
       throws IOException

Create new status.

Parameters:

status - Add this status

Returns:

The added status

Throws:

IOException - If there is any I/O problem

See Also:

• Create a Status

list

Iterable<Status> list(String ref)

List all statuses for a given ref.

Parameters:

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

Returns:

Iterable of statuses

See Also:

• List Statuses for a specific Ref