com.comphenix.protocol.updater

Class BukkitUpdater

java.lang.Object

com.comphenix.protocol.updater.Updater

com.comphenix.protocol.updater.BukkitUpdater

public class BukkitUpdater
extends Updater

Check dev.bukkit.org to find updates 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.0

Author:

Gravity

Nested Class Summary

Nested classes/interfaces inherited from class com.comphenix.protocol.updater.Updater

Updater.UpdateResult, Updater.UpdateType

Field Summary

Fields inherited from class com.comphenix.protocol.updater.Updater

announce, listeners, plugin, REPORT_CANNOT_UPDATE_PLUGIN, result, type, versionFileName, versionGameVersion, versionLink, versionName, versionType

Constructor Summary

Constructors

Constructor and Description
BukkitUpdater(org.bukkit.plugin.Plugin plugin, int id, File file, Updater.UpdateType type, boolean announce) Initialize the updater.

Method Summary

Modifier and Type	Method and Description
String	getRemoteVersion()
boolean	read() Evaluate whether the version number is marked showing that it should not be updated by this program
void	start(Updater.UpdateType type) Begin looking for updates.

Methods inherited from class com.comphenix.protocol.updater.Updater

addListener, create, getLatestFileLink, getLatestGameVersion, getLatestName, getLatestType, getResult, isChecking, removeListener, shouldNotify, versionCheck, waitForThread

Methods inherited from class java.lang.Object

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

Constructor Detail

BukkitUpdater

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

Initialize the updater.

Call #start() to actually start looking (and downloading) updates.

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 UpdateType

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

Method Detail

start

public void start(Updater.UpdateType type)

Begin looking for updates.

Specified by:

start in class Updater

Parameters:

type - - the update type.

read

public boolean read()

Evaluate whether the version number is marked showing that it should not be updated by this program

getRemoteVersion

public String getRemoteVersion()

Specified by:

getRemoteVersion in class Updater