de.griefed.versionchecker

Class VersionChecker

java.lang.Object

de.griefed.versionchecker.VersionChecker

Direct Known Subclasses:

GitHubChecker, GitLabChecker

public abstract class VersionChecker
extends java.lang.Object

Baseclass from wich GitHub and GitLab checks extend. This class mainly provides the logic for comparing versions against each other to find out which is newer. Extend from this class if you want to implement your own checkers, for platforms like Gitea or anything else.

Constructor Summary

Constructors

Constructor and Description
VersionChecker()

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.List<java.lang.String>	allVersions()
java.lang.String	checkForUpdate(@NotNull java.lang.String currentVersion, boolean checkForPreReleases) Check whether an update/newer version is available for the given version.
protected java.util.List<java.lang.String>	getAllVersions()
abstract java.util.List<java.lang.String>	getAssetsDownloadUrls(@NotNull java.lang.String version)
protected abstract java.lang.String	getDownloadUrl(@NotNull java.lang.String version)
protected com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
protected java.lang.String	getResponse(@NotNull java.net.URL requestUrl) Acquire the response from a given URL.
protected java.lang.String	latestAlpha() Get the latest alpha release.
protected java.lang.String	latestBeta() Get the latest beta release.
protected abstract java.lang.String	latestVersion(boolean checkForPreRelease)
abstract VersionChecker	refresh()
protected void	setAllVersions()
protected abstract void	setRepository()

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionChecker

public VersionChecker()

Method Detail

checkForUpdate

public java.lang.String checkForUpdate(@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.

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:

String. Returns a concatenated String whether an update is available or not. Examples:
No update available: No updates available.
New release available: Current version: 2.0.0. A new release is available: 2.1.1. Download available at: https://github.com/Griefed/ServerPackCreator/releases/tag/2.1.1 New prerelease available: Current version: 2.0.0. A new PreRelease is available: 3.0.0-alpha.14. Download available at: https://github.com/Griefed/ServerPackCreator/releases/tag/3.0.0-alpha.14

latestBeta

protected java.lang.String latestBeta()
                               throws java.lang.NumberFormatException

Get the latest beta release.

Returns:

String. Returns the latest beta release. If no beta release is available, no_betas is returned.

Throws:

java.lang.NumberFormatException - Thrown if a version can not be parsed into integers.

latestAlpha

protected java.lang.String latestAlpha()
                                throws java.lang.NumberFormatException

Get the latest alpha release.

Returns:

String. Returns the latest alpha release. If no alpha release is available, no_alphas is returned.

Throws:

java.lang.NumberFormatException - Thrown if a versions can not be parsed into integers.

getResponse

protected java.lang.String getResponse(@NotNull
                                       @NotNull java.net.URL requestUrl)
                                throws java.io.IOException

Acquire the response from a given URL.

Parameters:

requestUrl - String. The URL to get the response from.

Returns:

String. The response from the given URL.

Throws:

java.io.IOException - Thrown if the requested URL can not be reached or if any other error occurs during the request.

getObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

allVersions

protected abstract java.util.List<java.lang.String> allVersions()

refresh

public abstract VersionChecker refresh()
                                throws java.io.IOException

Throws:

java.io.IOException

setAllVersions

protected void setAllVersions()

getAllVersions

protected java.util.List<java.lang.String> getAllVersions()

latestVersion

protected abstract java.lang.String latestVersion(boolean checkForPreRelease)

getDownloadUrl

protected abstract java.lang.String getDownloadUrl(@NotNull
                                                   @NotNull java.lang.String version)

setRepository

protected abstract void setRepository()
                               throws java.io.IOException

Throws:

java.io.IOException

getAssetsDownloadUrls

public abstract java.util.List<java.lang.String> getAssetsDownloadUrls(@NotNull
                                                                       @NotNull java.lang.String version)