com.jcabi.github

Interface Repos

@Immutable
public interface Repos

Github Repo API.

Since:

0.5

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Repos API

Method Summary

Methods

Modifier and Type	Method and Description
Repo	create(javax.json.JsonObject json) Create repository.
Repo	get(Coordinates coords) Get repository by name.
Github	github() Get its owner.
Iterable<Repo>	iterate(String identifier) Iterate all public repos, starting with the one you've seen already.
void	remove(Coordinates coords) Remove repository by name.

Method Detail

github

@NotNull(message="github is never NULL")
Github github()

Get its owner.

Returns:

Github

create

@NotNull(message="repository is never NULL")
Repo create(@NotNull(message="JSON can\'t be NULL")
                         javax.json.JsonObject json)
            throws IOException

Create repository.

Parameters:

json - Repository creation JSON

Returns:

Repository

Throws:

IOException - If there is any I/O problem

Since:

0.5

See Also:

Create Repository

get

@NotNull(message="repository is never NULL")
Repo get(@NotNull(message="coordinates can\'t be NULL")
                      Coordinates coords)

Get repository by name.

Parameters:

coords - Repository name in "user/repo" format

Returns:

Repository

See Also:

Get Repository

remove

void remove(@NotNull(message="coordinates can\'t be NULL")
          Coordinates coords)
            throws IOException

Remove repository by name.

Note: Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.

Parameters:

coords - Repository name in "user/repo" format

Throws:

IOException - If there is any I/O problem

See Also:

Delete a Repository

iterate

@NotNull(message="iterable is never NULL")
Iterable<Repo> iterate(@NotNull(message="identifier can\'t be NULL")
                                    String identifier)

Iterate all public repos, starting with the one you've seen already.

Parameters:

identifier - The integer ID of the last Repo that you’ve seen.

Returns:

Iterator of repo

See Also:

List all public repositories