io.github.bedwarsrel.updater

Class PluginUpdater

java.lang.Object

io.github.bedwarsrel.updater.PluginUpdater

public class PluginUpdater
extends Object

Check for updates on BukkitDev for a given plugin, and download the updates if needed.

VERY, VERY IMPORTANT: Because there are no standards for adding auto-update toggles in your plugin's config, this system provides NO CHECK WITH YOUR CONFIG to make sure the user has allowed auto-updating.
It is a BUKKIT POLICY that you include a boolean value in your config that prevents the auto-updater from running AT ALL.
If you fail to include this option in your config, your plugin will be REJECTED when you attempt to submit it to dev.bukkit.org.

An example of a good configuration option would be something similar to 'auto-update: true' - if this value is set to false you may NOT run the auto-updater.
If you are unsure about these rules, please read the plugin submission guidelines: http://goo.gl/8iU5l

Version:

2.3

Author:

Gravity

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginUpdater.ReleaseType Represents the various release types of a file on BukkitDev.
static interface	PluginUpdater.UpdateCallback Called on main thread when the updater has finished working, regardless of result.
static class	PluginUpdater.UpdateResult Gives the developer the result of the update process.
static class	PluginUpdater.UpdateType Allows the developer to specify the type of update that will be run.

Constructor Summary

Constructors

Constructor and Description
PluginUpdater(org.bukkit.plugin.Plugin plugin, int id, File file, PluginUpdater.UpdateType type, boolean announce) Initialize the updater.
PluginUpdater(org.bukkit.plugin.Plugin plugin, int id, File file, PluginUpdater.UpdateType type, PluginUpdater.UpdateCallback callback) Initialize the updater with the provided callback.
PluginUpdater(org.bukkit.plugin.Plugin plugin, int id, File file, PluginUpdater.UpdateType type, PluginUpdater.UpdateCallback callback, boolean announce) Initialize the updater with the provided callback.

Method Summary

Modifier and Type	Method and Description
String	getLatestFileLink() Get the latest version's direct file link.
String	getLatestGameVersion() Get the latest version's game version (such as "CB 1.2.5-R1.0").
String	getLatestName() Get the latest version's name (such as "Project v1.0").
PluginUpdater.ReleaseType	getLatestType() Get the latest version's release type.
PluginUpdater.UpdateResult	getResult() Get the result of the update process.
boolean	isLatestVersionCheck() Gets the latest version check result
boolean	shouldUpdate(String localVersion, String remoteVersion) If you wish to run mathematical versioning checks, edit this method.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginUpdater

public PluginUpdater(org.bukkit.plugin.Plugin plugin,
                     int id,
                     File file,
                     PluginUpdater.UpdateType type,
                     boolean announce)

Initialize the updater.

Parameters:

plugin - The plugin that is checking for an update.

id - The dev.bukkit.org id of the project.

file - The file that the plugin is running from, get this by doing this.getFile() from within your main class.

type - Specify the type of update this will be. See PluginUpdater.UpdateType

announce - True if the program should announce the progress of new updates in console.

PluginUpdater

public PluginUpdater(org.bukkit.plugin.Plugin plugin,
                     int id,
                     File file,
                     PluginUpdater.UpdateType type,
                     PluginUpdater.UpdateCallback callback)

Initialize the updater with the provided callback.

Parameters:

plugin - The plugin that is checking for an update.

id - The dev.bukkit.org id of the project.

file - The file that the plugin is running from, get this by doing this.getFile() from within your main class.

type - Specify the type of update this will be. See PluginUpdater.UpdateType

callback - The callback instance to notify when the updater has finished

PluginUpdater

public PluginUpdater(org.bukkit.plugin.Plugin plugin,
                     int id,
                     File file,
                     PluginUpdater.UpdateType type,
                     PluginUpdater.UpdateCallback callback,
                     boolean announce)

Initialize the updater with the provided callback.

Parameters:

plugin - The plugin that is checking for an update.

id - The dev.bukkit.org id of the project.

file - The file that the plugin is running from, get this by doing this.getFile() from within your main class.

type - Specify the type of update this will be. See PluginUpdater.UpdateType

callback - The callback instance to notify when the updater has finished

announce - True if the program should announce the progress of new updates in console.

Method Detail

getLatestFileLink

public String getLatestFileLink()

Get the latest version's direct file link.

Returns:

latest version's file link.

getLatestGameVersion

public String getLatestGameVersion()

Get the latest version's game version (such as "CB 1.2.5-R1.0").

Returns:

latest version's game version.

getLatestName

public String getLatestName()

Get the latest version's name (such as "Project v1.0").

Returns:

latest version's name.

getLatestType

public PluginUpdater.ReleaseType getLatestType()

Get the latest version's release type.

Returns:

latest version's release type.

See Also:

PluginUpdater.ReleaseType

getResult

public PluginUpdater.UpdateResult getResult()

Get the result of the update process.

Returns:

result of the update process.

See Also:

PluginUpdater.UpdateResult

isLatestVersionCheck

public boolean isLatestVersionCheck()

Gets the latest version check result

Returns:

latest version check result

shouldUpdate

public boolean shouldUpdate(String localVersion,
                            String remoteVersion)

If you wish to run mathematical versioning checks, edit this method.

With default behavior, updater will NOT verify that a remote version available on BukkitDev which is not this version is indeed an "update". If a version is present on BukkitDev that is not the version that is currently running, updater will assume that it is a newer version. This is because there is no standard versioning scheme, and creating a calculation that can determine whether a new update is actually an update is sometimes extremely complicated.

updater will call this method from versionCheck() before deciding whether the remote version is actually an update. If you have a specific versioning scheme with which a mathematical determination can be reliably made to decide whether one version is higher than another, you may revise this method, using the local and remote version parameters, to execute the appropriate check.

Returning a value of false will tell the update process that this is NOT a new version. Without revision, this method will always consider a remote version at all different from that of the local version a new update.

Parameters:

localVersion - the current version

remoteVersion - the remote version

Returns:

true if updater should consider the remote version an update, false if not.