com.jcabi.github

Interface Issues

@Immutable
public interface Issues

Github issues.

Since:

0.1

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Issues API

Method Summary

Methods

Modifier and Type	Method and 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.

Method Detail

repo

@NotNull(message="repository is never NULL")
Repo repo()

Owner of them.

Returns:

Repo

get

@NotNull(message="issue is never NULL")
Issue get(int number)

Get specific issue by number.

Parameters:

number - Issue number

Returns:

Issue

See Also:

Get a Single Issue

create

@NotNull(message="issue is never NULL")
Issue create(@NotNull(message="issue title is never NULL")
                          String title,
                          @NotNull(message="issue body is never NULL")
                          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

@NotNull(message="iterable is never NULL")
Iterable<Issue> iterate(@NotNull(message="map of params can\'t be NULL")
                                     Map<String,String> params)

Iterate them all.

Parameters:

params - Iterating parameters, as requested by API

Returns:

Iterator of issues

See Also:

List Issues