com.comphenix.protocol.metrics

Class Updater

java.lang.Object

com.comphenix.protocol.metrics.Updater

public class Updater
extends java.lang.Object

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

Modifier and Type	Class and Description
static class	Updater.UpdateResult Gives the dev the result of the update process.
static class	Updater.UpdateType Allows the dev to specify the type of update that will be run.

Field Summary

Fields

Modifier and Type	Field and Description
static ReportType	REPORT_CANNOT_UPDATE_PLUGIN

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(java.lang.Runnable listener) Add a listener to be executed when we have determined if an update is available.
java.lang.String	getLatestFileLink() Get the latest version's file link.
java.lang.String	getLatestGameVersion() Get the latest version's game version.
java.lang.String	getLatestName() Get the latest version's name.
java.lang.String	getLatestType() Get the latest version's release type (release, beta, or alpha).
Updater.UpdateResult	getResult() Get the result of the update process.
boolean	isChecking() Determine if we are already checking for an update.
boolean	removeListener(java.lang.Runnable listener) Remove a listener.
void	start(Updater.UpdateType type) Begin looking for updates.

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_CANNOT_UPDATE_PLUGIN

public static final ReportType REPORT_CANNOT_UPDATE_PLUGIN

Constructor Detail

Updater

public Updater(org.bukkit.plugin.Plugin plugin,
       int id,
       java.io.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 Updater.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.

Parameters:

type - - the update type.

addListener

public void addListener(java.lang.Runnable listener)

Add a listener to be executed when we have determined if an update is available.

The listener will be executed on the main thread.

Parameters:

listener - - the listener to add.

removeListener

public boolean removeListener(java.lang.Runnable listener)

Remove a listener.

Parameters:

listener - - the listener to remove.

Returns:

TRUE if the listener was removed, FALSE otherwise.

getResult

public Updater.UpdateResult getResult()

Get the result of the update process.

getLatestType

public java.lang.String getLatestType()

Get the latest version's release type (release, beta, or alpha).

getLatestGameVersion

public java.lang.String getLatestGameVersion()

Get the latest version's game version.

getLatestName

public java.lang.String getLatestName()

Get the latest version's name.

getLatestFileLink

public java.lang.String getLatestFileLink()

Get the latest version's file link.

isChecking

public boolean isChecking()

Determine if we are already checking for an update.

Returns:

TRUE if we are, FALSE otherwise.