Package me.despical.commons.util

Class UpdateChecker

java.lang.Object

me.despical.commons.util.UpdateChecker

public final class UpdateChecker
extends Object

A utility class to assist in checking for updates for plugins uploaded to SpigotMC. Before any members of this class are accessed, init(JavaPlugin, int) must be invoked by the plugin.

This class performs asynchronous queries to SpiGet, an REST server which is updated periodically. If the results of requestUpdateCheck() are inconsistent with what is published on SpigotMC, it may be due to SpiGet's cache. Results will be updated in due time.

Author:

Despical and Parker Hawke

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UpdateChecker.UpdateReason
final class	UpdateChecker.UpdateResult
static interface	UpdateChecker.VersionScheme

Field Summary

Fields

Modifier and Type	Field	Description
static final UpdateChecker.VersionScheme	VERSION_SCHEME_DECIMAL

Method Summary

Modifier and Type	Method	Description
static UpdateChecker	get()
UpdateChecker.UpdateResult	getLastResult()
static UpdateChecker	init(org.bukkit.plugin.java.JavaPlugin plugin, int pluginID)
static UpdateChecker	init(org.bukkit.plugin.java.JavaPlugin plugin, int pluginID, UpdateChecker.VersionScheme versionScheme)
static boolean	isInitialized()
void	onNewUpdate(Consumer<UpdateChecker.UpdateResult> resultConsumer)
CompletableFuture<UpdateChecker.UpdateResult>	requestUpdateCheck()

Methods inherited from class java.lang.Object

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

Field Details

VERSION_SCHEME_DECIMAL

public static final UpdateChecker.VersionScheme VERSION_SCHEME_DECIMAL

Method Details

init

public static UpdateChecker init(org.bukkit.plugin.java.JavaPlugin plugin,
 int pluginID,
 UpdateChecker.VersionScheme versionScheme)

init

public static UpdateChecker init(org.bukkit.plugin.java.JavaPlugin plugin,
 int pluginID)

get

public static UpdateChecker get()

isInitialized

public static boolean isInitialized()

onNewUpdate

public void onNewUpdate(Consumer<UpdateChecker.UpdateResult> resultConsumer)

requestUpdateCheck

public CompletableFuture<UpdateChecker.UpdateResult> requestUpdateCheck()

getLastResult

public UpdateChecker.UpdateResult getLastResult()