Package com.jcabi.github

Interface Issues

@Immutable
public interface Issues

Github issues.

Since:

0.1

Version:

$Id: 232b668446037da2513f01a12b6e0f63d96326c1 $

Author:

Yegor Bugayenko (yegor256@gmail.com), Chris Rebert (github@chrisrebert.com)

See Also:

Issues API

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Issues.Qualifier
static class	Issues.Sort

Method Summary

Modifier and Type	Method	Description
Issue	create(String title, String body)	Create new issue.
Issue	get(int number)	Get specific issue by number.
Iterable<Issue>	iterate(Map<String,String> params)	Iterate them all.
Repo	repo()	Owner of them.
Iterable<Issue>	search(Issues.Sort sort, Search.Order direction, EnumMap<Issues.Qualifier,String> qualifiers)	Search for issues within the given repository.

Method Detail

repo

Repo repo()

Owner of them.

Returns:

Repo

get

Issue get(int number)

Get specific issue by number.

Parameters:

number - Issue number

Returns:

Issue

See Also:

Get a Single Issue

create

Issue create(String title,
             String body)
      throws IOException

Create new issue.

Parameters:

title - Title

body - Body of it

Returns:

Issue just created

Throws:

IOException - If there is any I/O problem

See Also:

Create an Issue

iterate

Iterable<Issue> iterate(Map<String,String> params)

Iterate them all.

Parameters:

params - Iterating parameters, as requested by API

Returns:

Iterator of issues

See Also:

List Issues

search

Iterable<Issue> search(Issues.Sort sort,
                       Search.Order direction,
                       EnumMap<Issues.Qualifier,String> qualifiers)
                throws IOException

Search for issues within the given repository.

Parameters:

sort - The sort field

direction - The sort direction

qualifiers - The search qualifier

Returns:

Issues

Throws:

IOException - If there is any I/O problem

Since:

0.22.0

See Also:

List issues for a repository