Package xyz.srnyx.annoyingapi

Class UpdateChecker

java.lang.Object

xyz.srnyx.annoyingapi.parents.AnnoyableClass

xyz.srnyx.annoyingapi.UpdateChecker

All Implemented Interfaces:

Annoyable

public class UpdateChecker
extends AnnoyableClass

Class for handling update checking

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	UpdateChecker.LatestVersion

Field Summary

Fields

Modifier and Type	Field	Description
final @Nullable UpdateChecker.LatestVersion	latestVersion	The latest version of the plugin

Fields inherited from class xyz.srnyx.annoyingapi.parents.AnnoyableClass

annoyingPlugin

Constructor Summary

Constructors

Constructor	Description
UpdateChecker(@NotNull AnnoyingPlugin annoyingPlugin, @NotNull org.bukkit.plugin.PluginBase plugin, PluginPlatform.Multi platforms)	Creates a new UpdateChecker object
UpdateChecker(@NotNull AnnoyingPlugin annoyingPlugin, @NotNull org.bukkit.plugin.PluginDescriptionFile pluginDescription, PluginPlatform.Multi platforms)	Creates a new UpdateChecker object
UpdateChecker(@NotNull AnnoyingPlugin plugin, PluginPlatform.Multi platforms)	Creates a new UpdateChecker object

Method Summary

Modifier and Type	Method	Description
boolean	checkUpdate()	Checks if an update is available and sends a message to the console if it is
boolean	isUpdateAvailable()	Checks if an update is available
@NotNull String	toString()

Methods inherited from class xyz.srnyx.annoyingapi.parents.AnnoyableClass

getAnnoyingPlugin

Methods inherited from class java.lang.Object

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

Field Details

latestVersion

@Nullable
public final @Nullable UpdateChecker.LatestVersion latestVersion

The latest version of the plugin

Constructor Details

UpdateChecker

public UpdateChecker(@NotNull
 @NotNull AnnoyingPlugin annoyingPlugin,
 @NotNull
 @NotNull org.bukkit.plugin.PluginDescriptionFile pluginDescription,
 @NotNull
 PluginPlatform.Multi platforms)

Creates a new UpdateChecker object

Parameters:

annoyingPlugin - AnnoyableClass.annoyingPlugin

pluginDescription - pluginName and currentVersion

platforms - platforms

UpdateChecker

public UpdateChecker(@NotNull
 @NotNull AnnoyingPlugin annoyingPlugin,
 @NotNull
 @NotNull org.bukkit.plugin.PluginBase plugin,
 @NotNull
 PluginPlatform.Multi platforms)

Creates a new UpdateChecker object

Parameters:

annoyingPlugin - AnnoyableClass.annoyingPlugin

plugin - pluginName and currentVersion

platforms - platforms

UpdateChecker

public UpdateChecker(@NotNull
 @NotNull AnnoyingPlugin plugin,
 @NotNull
 PluginPlatform.Multi platforms)

Creates a new UpdateChecker object

Parameters:

plugin - AnnoyableClass.annoyingPlugin, pluginName, and currentVersion

platforms - platforms

Method Details

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

checkUpdate

public boolean checkUpdate()

Checks if an update is available and sends a message to the console if it is

Returns:

true if an update is available, false otherwise

isUpdateAvailable

public boolean isUpdateAvailable()

Checks if an update is available

Returns:

true if an update is available, false otherwise