de.pheasn.pluginupdater

Class Updater

java.lang.Object

java.lang.Thread

de.pheasn.pluginupdater.Updater

All Implemented Interfaces:

Runnable

public class Updater
extends Thread

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
Updater(Updatable plugin, int pluginId, File pluginFile, String apiKey, ReleaseChannel releaseChannel) Deprecated.
Updater(Updatable plugin, int pluginId, int interval, File pluginFile, String apiKey, ReleaseChannel releaseChannel) Gets a new instance of the updater.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels all update checking tasks.
boolean	check() Deprecated.
boolean	hasUpdatePending()
void	interrupt() Deprecated.
void	run()
void	scheduleNext() If update checks have somehow been canceled, they can be restarted by this method.
void	setInterval(long interval) Sets a new update interval
void	setReleaseType(ReleaseChannel releaseChannel) Changes the preferred release type Won't have effect until after next update check.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

Updater

@Deprecated
public Updater(Updatable plugin,
                  int pluginId,
                  File pluginFile,
                  String apiKey,
                  ReleaseChannel releaseChannel)

Deprecated.

Gets a new instance of the updater. Needs to be started.

Parameters:

plugin - JavaPlugin that shall be updated

pluginId - Bukkit.org plugin id

pluginFile - File of the plugin (you can use getFile())

apiKey - Bukkit apiKey, may be null

releaseChannel - Choose one of the ReleaseTypes

Updater

public Updater(Updatable plugin,
       int pluginId,
       int interval,
       File pluginFile,
       String apiKey,
       ReleaseChannel releaseChannel)

Gets a new instance of the updater. Needs to be started.

Parameters:

plugin - JavaPlugin that shall be updated

pluginId - Bukkit.org plugin id

interval - Update check interval

pluginFile - File of the plugin (you can use getFile())

apiKey - Bukkit apiKey, may be null

releaseChannel - Choose one of the ReleaseTypes

Method Detail

interrupt

@Deprecated
public void interrupt()

Deprecated.

Please use cancel() instead

Overrides:

interrupt in class Thread

setReleaseType

public void setReleaseType(ReleaseChannel releaseChannel)

Changes the preferred release type Won't have effect until after next update check.

Parameters:

releaseChannel - the ReleaseChannel

scheduleNext

public void scheduleNext()

If update checks have somehow been canceled, they can be restarted by this method.

check

@Deprecated
public boolean check()

Deprecated.

Checks for updates. Not recommended to do this "manually". Use scheduleNext() instead

Returns:

True if update has been found and downloaded

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

cancel

public void cancel()

Cancels all update checking tasks. You can restart the updater by invoking scheduleNext()

setInterval

public void setInterval(long interval)

Sets a new update interval

Parameters:

interval - the interval in milliseconds

hasUpdatePending

public boolean hasUpdatePending()