com.jcabi.github

Interface Issue

All Superinterfaces:

Comparable<Issue>, JsonPatchable, JsonReadable

All Known Implementing Classes:

Issue.Smart

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

Github issue.

Use a supplementary "smart" decorator to get other properties from an issue, for example:

 Issue.Smart issue = new Issue.Smart(origin);
 if (issue.isOpen()) {
   issue.close();
 }

Since:

0.1

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Issues API

Suppressed Checkstyle violations:

MultipleStringLiterals (500 lines)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Issue.Smart Smart Issue with extra features.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOSED_STATE Issue state.
static String	OPEN_STATE Issue state.

Method Summary

Methods

Modifier and Type	Method and Description
Comments	comments() Get all comments of the issue.
Iterable<Event>	events() Get all events of the issue.
boolean	exists() Is this issue exists in Github?
IssueLabels	labels() Get all labels of the issue.
int	number() Get its number.
Repo	repo() Repository 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

Field Detail

OPEN_STATE

static final String OPEN_STATE

Issue state.

See Also:

Constant Field Values

CLOSED_STATE

static final String CLOSED_STATE

Issue state.

See Also:

Constant Field Values

Method Detail

repo

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

Repository we're in.

Returns:

Repo

number

int number()

Get its number.

Returns:

Issue number

comments

@NotNull(message="comments are never NULL")
Comments comments()

Get all comments of the issue.

Returns:

Comments

See Also:

Issue Comments API

labels

@NotNull(message="labels are never NULL")
IssueLabels labels()

Get all labels of the issue.

Returns:

Labels

See Also:

Labels API

events

@NotNull(message="iterable of events is never NULL")
Iterable<Event> events()
                       throws IOException

Get all events of the issue.

Returns:

Events

Throws:

IOException - If there is any I/O problem

See Also:

List Events for an Issue

exists

boolean exists()
               throws IOException

Is this issue exists in Github?

Returns:

TRUE if this issue exists

Throws:

IOException - If there is any I/O problem