com.comphenix.protocol.updater

Class Updater

java.lang.Object

com.comphenix.protocol.updater.Updater

Direct Known Subclasses:

BukkitUpdater, SpigotUpdater

public abstract class Updater
extends Object

Author:

dmulloy2

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
protected boolean	announce
protected List<Runnable>	listeners
protected org.bukkit.plugin.Plugin	plugin
static ReportType	REPORT_CANNOT_UPDATE_PLUGIN
protected Updater.UpdateResult	result
protected Thread	thread
protected Updater.UpdateType	type
protected String	versionFileName
protected String	versionGameVersion
protected String	versionLink
protected String	versionName
protected String	versionType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Updater(org.bukkit.plugin.Plugin plugin, Updater.UpdateType type, boolean announce)

Method Summary

Modifier and Type	Method and Description
void	addListener(Runnable listener) Add a listener to be executed when we have determined if an update is available.
static Updater	create(ProtocolLib protocolLib, int id, File file, Updater.UpdateType type, boolean announce)
String	getLatestFileLink() Get the latest version's file link.
String	getLatestGameVersion() Get the latest version's game version.
String	getLatestName() Get the latest version's name.
String	getLatestType() Get the latest version's release type (release, beta, or alpha).
abstract String	getRemoteVersion()
String	getResult() Get the result of the update process.
boolean	isChecking() Determine if we are already checking for an update.
boolean	removeListener(Runnable listener) Remove a listener.
boolean	shouldNotify()
abstract void	start(Updater.UpdateType type)
boolean	versionCheck(String title)
protected void	waitForThread() As the result of Updater output depends on the thread's completion, it is necessary to wait for the thread to finish before allowing anyone to check the result.

Methods inherited from class java.lang.Object

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

Field Detail

plugin

protected org.bukkit.plugin.Plugin plugin

versionName

protected String versionName

versionLink

protected String versionLink

versionType

protected String versionType

versionGameVersion

protected String versionGameVersion

versionFileName

protected String versionFileName

type

protected Updater.UpdateType type

announce

protected boolean announce

thread

protected Thread thread

result

protected Updater.UpdateResult result

listeners

protected List<Runnable> listeners

REPORT_CANNOT_UPDATE_PLUGIN

public static final ReportType REPORT_CANNOT_UPDATE_PLUGIN

Constructor Detail

Updater

protected Updater(org.bukkit.plugin.Plugin plugin,
                  Updater.UpdateType type,
                  boolean announce)

Method Detail

versionCheck

public boolean versionCheck(String title)

addListener

public void addListener(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(Runnable listener)

Remove a listener.

Parameters:

listener - - the listener to remove.

Returns:

TRUE if the listener was removed, FALSE otherwise.

getResult

public String getResult()

Get the result of the update process.

getLatestType

public String getLatestType()

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

getLatestGameVersion

public String getLatestGameVersion()

Get the latest version's game version.

getLatestName

public String getLatestName()

Get the latest version's name.

getLatestFileLink

public String getLatestFileLink()

Get the latest version's file link.

waitForThread

protected void waitForThread()

As the result of Updater output depends on the thread's completion, it is necessary to wait for the thread to finish before allowing anyone to check the result.

isChecking

public boolean isChecking()

Determine if we are already checking for an update.

Returns:

TRUE if we are, FALSE otherwise.

create

public static Updater create(ProtocolLib protocolLib,
                             int id,
                             File file,
                             Updater.UpdateType type,
                             boolean announce)

start

public abstract void start(Updater.UpdateType type)

shouldNotify

public boolean shouldNotify()

getRemoteVersion

public abstract String getRemoteVersion()