org.llorllale.youtrack.api

Interface Projects

public interface Projects

Fetches projects from the YouTrack server.

Since:

0.4.0

Author:

George Aristy (george.aristy@gmail.com)

Method Summary

Modifier and Type	Method and Description
Project	create(String id, String name, User leader) Create a new Project.
Optional<Project>	get(String id) Returns the Project with the given id, if any.
Stream<Project>	stream() Returns a Stream with all accessible projects by the user's Login.

Method Detail

stream

Stream<Project> stream()
                throws IOException,
                       UnauthorizedException

Returns a Stream with all accessible projects by the user's Login.

Returns:

a Stream with all accessible projects by the user's Login

Throws:

IOException - if the server is unavailable

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

Since:

0.4.0

get

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

Returns the Project with the given id, if any.

Parameters:

id - the project's id

Returns:

the Project with the given id, if any

Throws:

IOException - if the server is unavailable

UnauthorizedException - if the user's Login is not authorized to perform this operation

Since:

0.6.0

create

Project create(String id,
               String name,
               User leader)
        throws IOException,
               UnauthorizedException

Create a new Project.

Parameters:

id - unique identifier of the project to be created. This short name will be used as prefix in issue IDs for this project.

name - unique, full name of the new project.

leader - user to be assigned as the project's leader.

Returns:

the newly-created project

Throws:

IOException - if the server is unavailable

UnauthorizedException - if the user's Login is not authorized to perform this operation

Since:

1.1.0