Package com.zetaplugins.zetacore.services.updatechecker

Class UpdateChecker

java.lang.Object

com.zetaplugins.zetacore.services.updatechecker.UpdateChecker

Direct Known Subclasses:

GitHubUpdateChecker, HangarUpdateChecker, ModrinthUpdateChecker

public abstract class UpdateChecker
extends Object

Abstract class for checking updates for a JavaPlugin. Subclasses should implement the checkForUpdates method to define how updates are checked.

Constructor Summary

Constructors

Constructor	Description
UpdateChecker(JavaPlugin plugin)	Constructs an UpdateChecker for the given plugin.

Method Summary

Modifier and Type	Method	Description
abstract void	checkForUpdates(boolean logMessage)	Checks for updates for the plugin.
String	getLatestVersion()
abstract String	getLatestVersionUrl()
protected Logger	getLogger()
protected String	getNewVersionConsoleMessage(String latestVersion, String currentVersion, String newVersionUrl)	Generates a console message indicating that a new version is available.
protected JavaPlugin	getPlugin()
boolean	isNewVersionAvailable()
protected void	setLatestVersion(String latestVersion)
protected void	setNewVersionAvailable(boolean available)

Methods inherited from class java.lang.Object

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

Constructor Details

UpdateChecker

public UpdateChecker(JavaPlugin plugin)

Constructs an UpdateChecker for the given plugin.

Parameters:

plugin - The JavaPlugin to check updates for

Method Details

checkForUpdates

public abstract void checkForUpdates(boolean logMessage)

Checks for updates for the plugin.

Parameters:

logMessage - If true, logs a message if a new version is available

getNewVersionConsoleMessage

protected String getNewVersionConsoleMessage(String latestVersion,
 String currentVersion,
 String newVersionUrl)

Generates a console message indicating that a new version is available.

Parameters:

latestVersion - The latest version available

currentVersion - The current version of the plugin

newVersionUrl - The URL to download the new version

Returns:

The formatted console message

setNewVersionAvailable

protected void setNewVersionAvailable(boolean available)

isNewVersionAvailable

public boolean isNewVersionAvailable()

setLatestVersion

protected void setLatestVersion(String latestVersion)

getLatestVersion

public String getLatestVersion()

getLatestVersionUrl

public abstract String getLatestVersionUrl()

getPlugin

protected JavaPlugin getPlugin()

getLogger

protected Logger getLogger()