eu.fthevenet.util.github

Class GithubApi

java.lang.Object

eu.fthevenet.util.github.GithubApi

public class GithubApi
extends java.lang.Object

A series of helper methods to wrap some GitHub APIs See: https://developer.github.com/v3/

Author:

Frederic Thevenet

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GITHUB_API_HOSTNAME
static java.lang.String	URL_PROTOCOL

Method Summary

Modifier and Type	Method and Description
java.util.List<GithubRelease>	getAllReleases(java.lang.String owner, java.lang.String repo) Returns a list of all release from the specified repository.
static GithubApi	getInstance() Returns the singleton instance of GithubApi
java.util.Optional<GithubRelease>	getLatestRelease(java.lang.String owner, java.lang.String repo) Returns the latest release from the specified repository.
java.util.Optional<GithubRelease>	getRelease(java.lang.String owner, java.lang.String repo, java.lang.String id) Returns a specific release from the specified repository.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GITHUB_API_HOSTNAME

public static final java.lang.String GITHUB_API_HOSTNAME

See Also:

Constant Field Values

URL_PROTOCOL

public static final java.lang.String URL_PROTOCOL

See Also:

Constant Field Values

Method Detail

getInstance

public static GithubApi getInstance()

Returns the singleton instance of GithubApi

Returns:

the singleton instance of GithubApi

getLatestRelease

public java.util.Optional<GithubRelease> getLatestRelease(java.lang.String owner,
                                                          java.lang.String repo)
                                                   throws java.io.IOException,
                                                          java.net.URISyntaxException

Returns the latest release from the specified repository.

Parameters:

owner - the repository's owner

repo - the repository's name

Returns:

An Optional that contains the latest release if it could be found.

Throws:

java.io.IOException - if an IO error occurs while communicating with GiHub

java.net.URISyntaxException - if the crafted URI is incorrect.

getRelease

public java.util.Optional<GithubRelease> getRelease(java.lang.String owner,
                                                    java.lang.String repo,
                                                    java.lang.String id)
                                             throws java.io.IOException,
                                                    java.net.URISyntaxException

Returns a specific release from the specified repository.

Parameters:

owner - the repository's owner

repo - the repository's name

id - the id of the release to retrieve

Returns:

An Optional that contains the specified release if it could be found.

Throws:

java.io.IOException - if an IO error occurs while communicating with GitHub.

java.net.URISyntaxException - if the crafted URI is incorrect.

getAllReleases

public java.util.List<GithubRelease> getAllReleases(java.lang.String owner,
                                                    java.lang.String repo)
                                             throws java.io.IOException,
                                                    java.net.URISyntaxException

Returns a list of all release from the specified repository.

Parameters:

owner - the repository's owner

repo - the repository's name

Returns:

a list of all release from the specified repository.

Throws:

java.io.IOException - if an IO error occurs while communicating with GitHub.

java.net.URISyntaxException - if the crafted URI is incorrect.