com.jcabi.github

Class Issue.Smart

java.lang.Object

com.jcabi.github.Issue.Smart

All Implemented Interfaces:

Issue, JsonPatchable, JsonReadable, Comparable<Issue>

Enclosing interface:

Issue

@Immutable
@Loggable(value=1)
public static final class Issue.Smart
extends Object
implements Issue

Smart Issue with extra features.

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 and Description
Issue.Smart(Issue iss) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
void	assign(String login) Assign this issue to another user.
User	assignee() Get its assignee.
User	author() Get its author.
String	body() Get its title.
void	body(String text) Change its body.
void	close() Close it (make sure it's closed).
Comments	comments() Get all comments of the issue.
int	compareTo(Issue obj)
Date	createdAt() When this issue was created.
Iterable<Event>	events() Get all events of the issue.
boolean	exists() Is this issue exists in Github?
URL	htmlUrl() Get its HTML URL.
boolean	isOpen() Is it open?
boolean	isPull() Is it a pull requests?
javax.json.JsonObject	json() Describe it in a JSON object.
IssueLabels	labels() Get all labels of the issue.
Event	latestEvent(String type) Get the latest event of a given type.
int	number() Get its number.
void	open() Open it (make sure it's open).
void	patch(javax.json.JsonObject json) Patch using this JSON object.
Pull	pull() Get pull request.
Repo	repo() Repository we're in.
IssueLabels	roLabels() Get read-only labels.
String	state() Get its state.
void	state(String state) Change its state.
String	title() Get its body.
void	title(String text) Change its state.
Date	updatedAt() When this issue was updated.
URL	url() Get its URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

Issue.Smart

public Issue.Smart(@NotNull(message="iss can\'t be NULL")
           Issue iss)

Public ctor.

Parameters:

iss - Issue

Method Detail

author

@NotNull(message="user is never NULL")
public User author()
            throws IOException

Get its author.

Returns:

Author of issue (who submitted it)

Throws:

IOException - If there is any I/O problem

isOpen

public boolean isOpen()
               throws IOException

Is it open?

Returns:

TRUE if it's open

Throws:

IOException - If there is any I/O problem

open

public void open()
          throws IOException

Open it (make sure it's open).

Throws:

IOException - If there is any I/O problem

close

public void close()
           throws IOException

Close it (make sure it's closed).

Throws:

IOException - If there is any I/O problem

state

@NotNull(message="state is never NULL")
public String state()
             throws IOException

Get its state.

Returns:

State of issue

Throws:

IOException - If there is any I/O problem

state

public void state(@NotNull(message="state can\'t be NULL")
         String state)
           throws IOException

Change its state.

Parameters:

state - State of issue

Throws:

IOException - If there is any I/O problem

title

@NotNull(message="title is never NULL")
public String title()
             throws IOException

Get its body.

Returns:

Body of issue

Throws:

IOException - If there is any I/O problem

title

public void title(@NotNull(message="text can\'t be NULL")
         String text)
           throws IOException

Change its state.

Parameters:

text - Text of issue

Throws:

IOException - If there is any I/O problem

body

@NotNull(message="body is never NULL")
public String body()
            throws IOException

Get its title.

Returns:

Title of issue

Throws:

IOException - If there is any I/O problem

body

public void body(@NotNull(message="text can\'t be NULL")
        String text)
          throws IOException

Change its body.

Parameters:

text - Body of issue

Throws:

IOException - If there is any I/O problem

assignee

@NotNull(message="user is never NULL")
public User assignee()
              throws IOException

Get its assignee.

Returns:

User Assignee of issue

Throws:

IOException - If there is any I/O problem

assign

public void assign(@NotNull(message="login can\'t be NULL")
          String login)
            throws IOException

Assign this issue to another user.

Parameters:

login - Login of the user to assign to

Throws:

IOException - If there is any I/O problem

url

@NotNull(message="URL is never NULL")
public URL url()
        throws IOException

Get its URL.

Returns:

URL of issue

Throws:

IOException - If there is any I/O problem

htmlUrl

@NotNull(message="URL is never NULL")
public URL htmlUrl()
            throws IOException

Get its HTML URL.

Returns:

URL of issue

Throws:

IOException - If there is any I/O problem

createdAt

@NotNull(message="date is never NULL")
public Date createdAt()
               throws IOException

When this issue was created.

Returns:

Date of creation

Throws:

IOException - If there is any I/O problem

updatedAt

@NotNull(message="date is never NULL")
public Date updatedAt()
               throws IOException

When this issue was updated.

Returns:

Date of update

Throws:

IOException - If there is any I/O problem

isPull

public boolean isPull()
               throws IOException

Is it a pull requests?

Returns:

TRUE if it is a pull request

Throws:

IOException - If there is any I/O problem

pull

@NotNull(message="pull is never NULL")
public Pull pull()
          throws IOException

Get pull request.

Returns:

Pull request

Throws:

IOException - If there is any I/O problem

latestEvent

@NotNull(message="event is never NULL")
public Event latestEvent(@NotNull(message="type can\'t be NULL")
                               String type)
                  throws IOException

Get the latest event of a given type.

Parameters:

type - Type of event

Returns:

Event found (runtime exception if it doesn't exist)

Throws:

IOException - If there is any I/O problem

roLabels

@NotNull(message="collection is never NULL")
public IssueLabels roLabels()
                     throws IOException

Get read-only labels.

Returns:

Collection of labels

Throws:

IOException - If there is any I/O problem

Since:

0.6.2

repo

@NotNull(message="repository is never NULL")
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

@NotNull(message="comments is never NULL")
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

@NotNull(message="labels is never NULL")
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

@NotNull(message="Iterable of events is never NULL")
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

json

@NotNull(message="JSON is never NULL")
public javax.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(@NotNull(message="json can\'t be NULL")
         javax.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

compareTo

public int compareTo(@NotNull(message="obj can\'t be NULL")
            Issue obj)

Specified by:

compareTo in interface Comparable<Issue>

exists

public boolean exists()
               throws IOException

Description copied from interface: Issue

Is this issue exists in Github?

Specified by:

exists in interface Issue

Returns:

TRUE if this issue exists

Throws:

IOException - If there is any I/O problem