org.llorllale.youtrack.api

Interface Comments

public interface Comments

API for comments on an Issue.

Since:

0.4.0

Author:

George Aristy (george.aristy@gmail.com)

Method Summary

Modifier and Type	Method and Description
Issue	issue() The parent Issue.
Comments	post(String text) Creates a new Comment for this Issue.
Stream<Comment>	stream() A Stream with all comments for this Issue.

Method Detail

stream

Stream<Comment> stream()
                throws IOException,
                       UnauthorizedException

A Stream with all comments for this Issue.

Returns:

A Stream with all comments for this Issue.

Throws:

IOException - if the server is unavailable

UnauthorizedException - if the user's Session is unauthorized to access this resource

Since:

0.4.0

post

Comments post(String text)
       throws IOException,
              UnauthorizedException

Creates a new Comment for this Issue.

Parameters:

text - the comment's text

Returns:

this Comments

Throws:

IOException - if the server is unavailable

UnauthorizedException - if the user's Session is unauthorized to perform this operation

Since:

0.4.0

issue

Issue issue()

The parent Issue.

Returns:

the parent Issue

Since:

0.9.0