lol.hyper.githubreleaseapi

Class GitHubReleaseAPI

java.lang.Object

lol.hyper.githubreleaseapi.GitHubReleaseAPI

public class GitHubReleaseAPI
extends Object

Constructor Summary

Constructors

Constructor and Description
GitHubReleaseAPI(@NotNull String repoName, @NotNull String orgName) Create an API object.

Method Summary

Modifier and Type	Method and Description
@NotNull List<GitHubRelease>	getAllReleases() Get all the releases the GitHub project.
int	getBuildsBehind(GitHubRelease release) Get how many versions behind a release is.
@NotNull GitHubRelease	getLatestVersion() Get the latest release.
@NotNull GitHubRelease	getReleaseByTag(@NotNull String tag) Get a release by a given tag.
String	getRepoURL() Get the repository's URL.
void	refreshReleases() Refresh the releases for this repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHubReleaseAPI

public GitHubReleaseAPI(@NotNull
                        @NotNull String repoName,
                        @NotNull
                        @NotNull String orgName)
                 throws IOException

Create an API object. This object is bound to 1 repository.

Parameters:

repoName - The repository name.

orgName - The name of the user OR organization the repository is on.

Throws:

IOException

Method Detail

getAllReleases

@NotNull
public @NotNull List<GitHubRelease> getAllReleases()

Get all the releases the GitHub project.

Returns:

A list of all the releases.

getBuildsBehind

public int getBuildsBehind(GitHubRelease release)

Get how many versions behind a release is.

Parameters:

release - The release you want to check.

Returns:

The number of builds behind from (release) to (latest)

getLatestVersion

@NotNull
public @NotNull GitHubRelease getLatestVersion()

Get the latest release.

Returns:

Latest release.

getReleaseByTag

@NotNull
public @NotNull GitHubRelease getReleaseByTag(@NotNull
                                                        @NotNull String tag)

Get a release by a given tag.

Parameters:

tag - The tag to search for.

Returns:

The release from given tag.

getRepoURL

public String getRepoURL()

Get the repository's URL.

Returns:

GitHub URL to the repository.

refreshReleases

public void refreshReleases()
                     throws IOException

Refresh the releases for this repository.

Throws:

IOException