Package com.jcabi.github.safe

Class SfIssue

java.lang.Object

com.jcabi.github.safe.SfIssue

All Implemented Interfaces:

Issue, JsonPatchable, JsonReadable, Comparable<Issue>

@Immutable
@Loggable(1)
public final class SfIssue
extends Object
implements Issue

Safe issue.

Since:

0.36

Nested Class Summary

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

Issue.Smart

Field Summary

Fields inherited from interface com.jcabi.github.Issue

CLOSED_STATE, OPEN_STATE

Constructor Summary

Constructors

Constructor	Description
SfIssue(Issue issue)	Public ctor.

Method Summary

Modifier and Type	Method	Description
Comments	comments()	Get all comments of the issue.
int	compareTo(Issue issue)
Iterable<Event>	events()	Get all events of the issue.
boolean	exists()	Does this issue exist in GitHub?
boolean	isLocked()	The issue conversation is locked?
jakarta.json.JsonObject	json()	Describe it in a JSON object.
IssueLabels	labels()	Get all labels of the issue.
void	lock(String reason)	Locks the issue.
int	number()	Get its number.
void	patch(jakarta.json.JsonObject json)	Patch using this JSON object.
void	react(Reaction reaction)	Adds the reaction to the issue.
Iterable<Reaction>	reactions()	List the reactions of the issue.
Repo	repo()	Repository we're in.
String	toString()
void	unlock()	Unlocks the issue.

Methods inherited from class java.lang.Object

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

Constructor Details

SfIssue

public SfIssue(Issue issue)

Public ctor.

Parameters:

issue - The original issue

Method Details

toString

public String toString()

Overrides:

toString in class Object

json

public jakarta.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(jakarta.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

repo

public Repo repo()

Description copied from interface: Issue

Repository we're in.

Specified by:

repo in interface Issue

Returns:

Repo

number

public int number()

Description copied from interface: Issue

Get its number.

Specified by:

number in interface Issue

Returns:

Issue number

comments

public Comments comments()

Description copied from interface: Issue

Get all comments of the issue.

Specified by:

comments in interface Issue

Returns:

Comments

See Also:

• Issue Comments API

labels

public IssueLabels labels()

Description copied from interface: Issue

Get all labels of the issue.

Specified by:

labels in interface Issue

Returns:

Labels

See Also:

• Labels API

events

public Iterable<Event> events()
                       throws IOException

Description copied from interface: Issue

Get all events of the issue.

Specified by:

events in interface Issue

Returns:

Events

Throws:

IOException - If there is any I/O problem

See Also:

• List Events for an Issue

exists

public boolean exists()
               throws IOException

Description copied from interface: Issue

Does this issue exist in GitHub?

Specified by:

exists in interface Issue

Returns:

TRUE if this issue exists

Throws:

IOException - If there is any I/O problem

compareTo

public int compareTo(Issue issue)

Specified by:

compareTo in interface Comparable<Issue>

react

public void react(Reaction reaction)
           throws IOException

Description copied from interface: Issue

Adds the reaction to the issue.

Specified by:

react in interface Issue

Parameters:

reaction - Reaction to be added.

Throws:

IOException - If there is any I/O problem

reactions

public Iterable<Reaction> reactions()

Description copied from interface: Issue

List the reactions of the issue.

Specified by:

reactions in interface Issue

Returns:

Issue reactions.

lock

public void lock(String reason)

Description copied from interface: Issue

Locks the issue.

Specified by:

lock in interface Issue

Parameters:

reason - Lock reason

unlock

public void unlock()

Description copied from interface: Issue

Unlocks the issue.

Specified by:

unlock in interface Issue

isLocked

public boolean isLocked()

Description copied from interface: Issue

The issue conversation is locked?

Specified by:

isLocked in interface Issue

Returns:

If the issue is locked.