Package com.jcabi.github.safe

Class SfComments

java.lang.Object

com.jcabi.github.safe.SfComments

All Implemented Interfaces:

Comments

@Immutable
@Loggable(1)
public final class SfComments
extends Object
implements Comments

Safe comments.

Since:

0.34

Version:

$Id: 71afe4932b946ae01b7a3752313c9fa2cdf6c9dc $

Author:

Yegor Bugayenko ([email protected])

Constructor Summary

Constructors

Constructor	Description
SfComments(Comments cmt)	Public ctor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SfComments

public SfComments(Comments cmt)

Public ctor.

Parameters:

cmt - The original comment

Method Detail

toString

public String toString()

Overrides:

toString in class Object

issue

public Issue issue()

Description copied from interface: Comments

The issue we're in.

Specified by:

issue in interface Comments

Returns:

Issue

get

public Comment get(int number)

Description copied from interface: Comments

Get comment by number.

Specified by:

get in interface Comments

Parameters:

number - Comment number

Returns:

Comment

See Also:

Get a Single Comment

iterate

public Iterable<Comment> iterate(Date since)

Description copied from interface: Comments

Iterate them all.

Specified by:

iterate in interface Comments

Parameters:

since - Since when? Just give new Date(0) if you want all comments.

Returns:

All comments

See Also:

List Comments on an Issue

post

public Comment post(String text)
             throws IOException

Description copied from interface: Comments

Post new comment.

Specified by:

post in interface Comments

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