com.jcabi.github

Interface Comments

@Immutable
public interface Comments

Github comments.

Use this class to get access to all comments in an issue, for example:

 issue = // ... get it somewhere
 Comments comments = issue.comments();
 Comment comment = comments.post("Hi, how are you?");

Since:

0.1

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Issue Comments API

Method Summary

Methods

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

Method Detail

issue

@NotNull(message="issue is never NULL")
Issue issue()

The issue we're in.

Returns:

Issue

get

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

Iterate them all.

Returns:

All comments

See Also:

List Comments on an Issue

post

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