com.jcabi.github

Class GistComment.Smart

java.lang.Object

com.jcabi.github.GistComment.Smart

All Implemented Interfaces:

GistComment, JsonPatchable, JsonReadable, Comparable<GistComment>

Enclosing interface:

GistComment

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

Smart comment with additional features.

Nested Class Summary

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

GistComment.Smart

Constructor Summary

Constructors

Constructor and Description
GistComment.Smart(GistComment cmt) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
User	author() Get its author.
String	body() Get its body.
void	body(String text) Change comment body.
int	compareTo(GistComment cmt)
Date	createdAt() When this comment was created.
Gist	gist() The gist it's in.
javax.json.JsonObject	json() Describe it in a JSON object.
int	number() Number.
void	patch(javax.json.JsonObject json) Patch using this JSON object.
void	remove() Delete the comment.
Date	updatedAt() When this comment was updated last time.
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

GistComment.Smart

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

Public ctor.

Parameters:

cmt - Comment

Method Detail

author

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

Get its author.

Returns:

Author of comment

Throws:

IOException - If there is any I/O problem

body

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

Get its body.

Returns:

Body of comment

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 comment body.

Parameters:

text - Body of comment

Throws:

IOException - If there is any I/O problem

url

@NotNull(message="URL can\'t be NULL")
public URL url()
        throws IOException

Get its URL.

Returns:

URL of comment

Throws:

IOException - If there is any I/O problem

createdAt

@NotNull(message="date can\'t be NULL")
public Date createdAt()
               throws IOException

When this comment was created.

Returns:

Date of creation

Throws:

IOException - If there is any I/O problem

updatedAt

@NotNull(message="date can\'t be NULL")
public Date updatedAt()
               throws IOException

When this comment was updated last time.

Returns:

Date of update

Throws:

IOException - If there is any I/O problem

gist

@NotNull(message="gist is never NULL")
public Gist gist()

Description copied from interface: GistComment

The gist it's in.

Specified by:

gist in interface GistComment

Returns:

Owner of the comment

number

public int number()

Description copied from interface: GistComment

Number.

Specified by:

number in interface GistComment

Returns:

Comment id

remove

public void remove()
            throws IOException

Description copied from interface: GistComment

Delete the comment.

Specified by:

remove in interface GistComment

Throws:

IOException - If there is any I/O problem

See Also:

Delete a Comment

compareTo

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

Specified by:

compareTo in interface Comparable<GistComment>

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

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