de.griefed.versionchecker

Class GitHubChecker

java.lang.Object

de.griefed.versionchecker.VersionChecker

de.griefed.versionchecker.GitHubChecker

public class GitHubChecker
extends VersionChecker

Check a given GitHub repository for updates.
Versions are checked for semantic-release-formatting. Meaning tags must look like the following examples:
2.0.0
2.1.1
3.0.0-alpha.1
3.0.0-alpha.13
1.2.3-beta.1
and so on.

Constructor Summary

Constructors

Constructor and Description
GitHubChecker(@NotNull java.lang.String gitHubUserRepository) Constructs a GitHub checker with the given user/repository combination to allow for version checks as well as version and URL acquisition.
GitHubChecker(@NotNull java.lang.String user, @NotNull java.lang.String repository) Constructs a GitHub checker with the given user/repository combination to allow for version checks as well as version and URL acquisition.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	allVersions() Gather a list of all available versions for the given repository.
java.util.Optional<Update>	check(@NotNull java.lang.String currentVersion, boolean checkForPreReleases) Check whether an update/newer version is available for the given version.
java.util.List<java.lang.String>	getAssetsDownloadUrls(@NotNull java.lang.String requestedVersion) Deprecated. The aim of VersionChecker is not to browse a given repository, but to check for availability of updates, and if an update is available, work from there. See check(String, boolean) which returns an instance of Update. This provides everything you need.
java.lang.String	getDownloadUrl(@NotNull java.lang.String version) Get the URL for the given release version.
java.lang.String	latestVersion(boolean checkForPreRelease) Get the latest regular release, or pre-release if checkForPreRelease is true.
GitHubChecker	refresh() Refresh this GitHub-instance.
protected void	setRepository() Acquire this instances repository information and store it in a JsonNode for later use.

Methods inherited from class de.griefed.versionchecker.VersionChecker

checkForUpdate, compareSemantics, getAllVersions, getObjectMapper, getResponse, isUpdateAvailable, latestAlpha, latestBeta, setAllVersions

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHubChecker

public GitHubChecker(@NotNull
                     @NotNull java.lang.String gitHubUserRepository)
              throws java.net.MalformedURLException

Constructs a GitHub checker with the given user/repository combination to allow for version checks as well as version and URL acquisition.

Parameters:

gitHubUserRepository - String. GitHub user/repository-combination. For example Griefed/ServerPackCreator

Throws:

java.net.MalformedURLException - Thrown if the resulting URL is malformed or otherwise invalid.

GitHubChecker

public GitHubChecker(@NotNull
                     @NotNull java.lang.String user,
                     @NotNull
                     @NotNull java.lang.String repository)
              throws java.net.MalformedURLException

Constructs a GitHub checker with the given user/repository combination to allow for version checks as well as version and URL acquisition.

Parameters:

user - String GitHub user and owner of the repository.

repository - String GitHub repository owned by the aforementioned user.

Throws:

java.net.MalformedURLException - Thrown if the resulting URL is malformed or otherwise invalid.

Method Detail

refresh

public GitHubChecker refresh()
                      throws java.io.IOException

Refresh this GitHub-instance. Refreshes repository information, the latest version, as well as a list of all available versions.

Specified by:

refresh in class VersionChecker

Returns:

This GitHub-instance.

Throws:

java.io.IOException - Exception thrown if setRepository() or setLatest() encounter an error.

check

public java.util.Optional<Update> check(@NotNull
                                        @NotNull java.lang.String currentVersion,
                                        boolean checkForPreReleases)

Check whether an update/newer version is available for the given version. If you want to check for PreReleases, too, then make sure to pass true for checkForPreReleases.

Specified by:

check in class VersionChecker

Parameters:

currentVersion - String. The current version of the app.

checkForPreReleases - Boolean. false if you do not want to check for PreReleases. true if you want to check for PreReleases as well.

Returns:

Update-instance, wrapped in an Optional, contianing information about the available update.

allVersions

public java.util.List<java.lang.String> allVersions()

Gather a list of all available versions for the given repository.

Specified by:

allVersions in class VersionChecker

Returns:

List String. Returns a list of all available versions. If an error occurred, or no versions are available, null is returned.

latestVersion

public java.lang.String latestVersion(boolean checkForPreRelease)

Get the latest regular release, or pre-release if checkForPreRelease is true.

Specified by:

latestVersion in class VersionChecker

Parameters:

checkForPreRelease - Boolean. Whether to include alpha and beta releases for latest release versions.

Returns:

String. Returns the latest regular release. If no regular release is available, no_release is returned.

getDownloadUrl

public java.lang.String getDownloadUrl(@NotNull
                                       @NotNull java.lang.String version)

Get the URL for the given release version.

Specified by:

getDownloadUrl in class VersionChecker

Parameters:

version - String. The version for which to get the URL to.

Returns:

String. Returns the URL to the given release version.

setRepository

protected void setRepository()
                      throws java.io.IOException

Acquire this instances repository information and store it in a JsonNode for later use.

Specified by:

setRepository in class VersionChecker

Throws:

java.io.IOException - Thrown if the repository can not be reached or any other unexpected error occurs.

getAssetsDownloadUrls

@Deprecated
public java.util.List<java.lang.String> getAssetsDownloadUrls(@NotNull
                                                                          @NotNull java.lang.String requestedVersion)

Deprecated. The aim of VersionChecker is not to browse a given repository, but to check for availability of updates, and if an update is available, work from there. See check(String, boolean) which returns an instance of Update. This provides everything you need.

Get the asset download URLs for a particular tag/version.

Specified by:

getAssetsDownloadUrls in class VersionChecker

Parameters:

requestedVersion - String. The version you want to retrieve the asset download URLs for.

Returns:

List String. A list of download URLs for the assets of the given tag/version.