org.llorllale.youtrack.api

Interface Issues

public interface Issues

Issues API.

Since:

0.4.0

Author:

George Aristy (george.aristy@gmail.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Issues.IssueSpec Specifications for building an Issue.

Method Summary

Modifier and Type	Method and Description
Issue	create(Issues.IssueSpec spec) Creates an issue according to the spec.
Optional<Issue>	get(String id) The Issue with the given id, if it exists.
Project	project() This Issues' Project.
Stream<Issue>	stream() A Stream with all issues created for this Project.

Method Detail

project

Project project()

This Issues' Project.

Returns:

this Issues' Project

Since:

0.4.0

stream

Stream<Issue> stream()
              throws IOException,
                     UnauthorizedException

A Stream with all issues created for this Project.

Returns:

a Stream with all issues for this project

Throws:

IOException - if the server is unavailable

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

Since:

0.4.0

get

Optional<Issue> get(String id)
             throws IOException,
                    UnauthorizedException

The Issue with the given id, if it exists.

Parameters:

id - the issue's id

Returns:

The Issue with the given id, if it exists.

Throws:

IOException - if the server is unavailable

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

Since:

0.4.0

create

Issue create(Issues.IssueSpec spec)
      throws IOException,
             UnauthorizedException

Creates an issue according to the spec.

Parameters:

spec - the specifications for creating the issue

Returns:

the newly-created Issue

Throws:

IOException - if the server is unavailable

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

Since:

0.4.0