SpigotMCUpdateChecker

java.lang.Object

wtf.choco.veinminer.update.SpigotMCUpdateChecker

All Implemented Interfaces:: UpdateChecker

public final class SpigotMCUpdateChecker extends Object implements UpdateChecker

An UpdateChecker implementation that queries the SpigotMC API.

Constructor Summary

Constructors

Constructor

Description

SpigotMCUpdateChecker(@NotNull JavaPlugin plugin, int pluginId)

Construct a new SpigotMCUpdateChecker.
Method Summary

Modifier and Type

Method

Description

@NotNull CompletableFuture<UpdateResult>

checkForUpdates(@NotNull VersionScheme versionScheme)

Perform an asynchronous update check.

@NotNull Optional<UpdateResult>

getLastUpdateResult()

Get the result of the last update check that was performed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- SpigotMCUpdateChecker
  
  public SpigotMCUpdateChecker(@NotNull @NotNull JavaPlugin plugin, int pluginId)
  
  Construct a new SpigotMCUpdateChecker.
  
  Parameters:
  
  plugin - the plugin instance
  
  pluginId - the id of the plugin (found on the SpigotMC website)
Method Details
- getLastUpdateResult
  
  @NotNull public @NotNull Optional<UpdateResult> getLastUpdateResult()
  
  Description copied from interface: UpdateChecker
  
  Get the result of the last update check that was performed.
  
  Specified by:
  
  getLastUpdateResult in interface UpdateChecker
  
  Returns:
  
  the last update result, or an empty Optional if an update check has not yet been performed
- checkForUpdates
  
  @NotNull public @NotNull CompletableFuture<UpdateResult> checkForUpdates(@NotNull @NotNull VersionScheme versionScheme)
  
  Description copied from interface: UpdateChecker
  
  Perform an asynchronous update check.
  
  Specified by:
  
  checkForUpdates in interface UpdateChecker
  
  Parameters:
  
  versionScheme - the VersionScheme to use
  
  Returns:
  
  a CompletableFuture containing the UpdateResult