com.jcabi.github

Interface Github

All Known Implementing Classes:

MkGithub, RtGithub

@Immutable
public interface Github

Github client, starting point to the entire library.

This is how you start communicating with Github API:

 Github github = new RtGithub(oauthKey);
 Repo repo = github.repos().get(
     new Coordinates.Simple("jcabi/jcabi-github")
 );
 Issues issues = repo.issues();
 Issue issue = issues.post("issue title", "issue body");

It is strongly recommended to use RetryWire to avoid accidental I/O exceptions:

 Github github = new RtGithub(
   new RtGithub(oauthKey)
     .entry()
     .through(RetryWire.class)
 );

The interfaces in this packages are trying to cover as much as possible of Github API. However, there are parts of API that are rarely used and making Java classes for them is not an effective idea. That's why Github class has entry() method, which returns an entry point to the RESTful API. For example, you want to use "Search Repositories" feature of Github:

 Github github = new RtGithub(oauthKey);
 int found = github.entry()
   .uri().path("/search/repositories").back()
   .method(Request.GET)
   .fetch()
   .as(JsonResponse.class)
   .getJsonObject()
   .getNumber("total_count")
   .intValue();

Since:

0.1

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Github.Time Time in Github JSON.

Method Summary

Methods

Modifier and Type	Method and Description
javax.json.JsonObject	emojis() Get emojis.
com.jcabi.http.Request	entry() RESTful request, an entry point to the Github API.
Gists	gists() Get Gists API entry point.
Gitignores	gitignores() Get gitignores.
Limits	limits() Rate limit API entry point.
Markdown	markdown() Get Markdown API entry point.
javax.json.JsonObject	meta() Get meta information.
Repos	repos() Get repositories.
Search	search() Search API entry point.
Users	users() Get Users API entry point.

Method Detail

entry

@NotNull(message="request is never NULL")
com.jcabi.http.Request entry()

RESTful request, an entry point to the Github API.

Returns:

Request

repos

@NotNull(message="list of repositories is never NULL")
Repos repos()

Get repositories.

Returns:

Repositories

gists

@NotNull(message="gists is never NULL")
Gists gists()

Get Gists API entry point.

Returns:

Gists API entry point

users

@NotNull(message="users is never NULL")
Users users()

Get Users API entry point.

Returns:

Users API entry point

Since:

0.4

markdown

@NotNull(message="markdown API is never NULL")
Markdown markdown()

Get Markdown API entry point.

Returns:

Markdown API entry point

Since:

0.6

limits

@NotNull(message="rate limit API is never NULL")
Limits limits()

Rate limit API entry point.

Returns:

Rate limit API

Since:

0.6

search

@NotNull(message="search API is never NULL")
Search search()

Search API entry point.

Returns:

Search API

Since:

0.8

gitignores

@NotNull(message="gitignores JSON is never NULL")
Gitignores gitignores()
                      throws IOException

Get gitignores.

Returns:

Gitignotes API

Throws:

IOException - If there is any I/O problem

Since:

0.8

See Also:

Gitignore API

meta

@NotNull(message="meta JSON is never NULL")
javax.json.JsonObject meta()
                           throws IOException

Get meta information.

Returns:

JSON with meta

Throws:

IOException - If there is any I/O problem

Since:

0.6

See Also:

Meta API

emojis

@NotNull(message="emojis JSON is never NULL")
javax.json.JsonObject emojis()
                             throws IOException

Get emojis.

Returns:

JSON with emojis

Throws:

IOException - If there is any I/O problem

Since:

0.6

See Also:

Emojis API