com.jcabi.github

Interface GistComments

@Immutable
public interface GistComments

Gist Comments.

Use this class to get access to all comments in a gist, for example:

 gist = // ... get it somewhere
 GistComments comments = gist.comments();
 GistComment comment = comments.post("Hi, how are you?");

Since:

0.8

Version:

$Id$

Author:

Giang Le (giang@vn-smartsolutions.com)

See Also:

Gist Comments API

Method Summary

Methods

Modifier and Type	Method and Description
GistComment	get(int number) Get comment by number.
Gist	gist() The gist we're in.
Iterable<GistComment>	iterate() Iterate them all.
GistComment	post(String text) Post new comment.

Method Detail

gist

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

The gist we're in.

Returns:

Issue

get

@NotNull(message="comment is never NULL")
GistComment get(int number)

Get comment by number.

Parameters:

number - Comment number

Returns:

Comment

See Also:

Get a Single Comment

iterate

@NotNull(message="iterable is never NULL")
Iterable<GistComment> iterate()

Iterate them all.

Returns:

All comments

See Also:

List Comments on an Gist

post

@NotNull(message="comment is never NULL")
GistComment post(@NotNull(message="text can\'t be NULL")
                              String text)
                 throws IOException

Post new comment.

Parameters:

text - Text of comment to post in Markdown format

Returns:

Comment

Throws:

IOException - If there is any I/O problem

See Also:

Create a Comment