de.pheasn.pluginupdater

Class Updater

java.lang.Object

de.pheasn.pluginupdater.Updater

public abstract class Updater
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Updater.Builder

Method Summary

Modifier and Type	Method and Description
static Updater.Builder	builder()
void	cancel() Cancels all scheduled update checks.
abstract String	getApiKey() Returns the server owner's API key.
abstract Updatable	getPlugin() Returns the updatable plugin.
abstract int	getPluginId() Returns the plugin's Bukkit ID.
abstract ReleaseChannel	getReleaseChannel() Returns the minimum ReleaseChannel.
void	setInterval(long interval) Sets the update check interval in minutes.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static Updater.Builder builder()

getApiKey

@Nullable
public abstract String getApiKey()

Returns the server owner's API key.

Returns:

the API key

getReleaseChannel

public abstract ReleaseChannel getReleaseChannel()

Returns the minimum ReleaseChannel.

Returns:

the ReleaseChannel

getPluginId

public abstract int getPluginId()

Returns the plugin's Bukkit ID.

Returns:

the ID

getPlugin

public abstract Updatable getPlugin()

Returns the updatable plugin.

Returns:

the Updatable

setInterval

public void setInterval(long interval)

Sets the update check interval in minutes.

Parameters:

interval - the new check interval. Must be greater or equal 5

cancel

public void cancel()

Cancels all scheduled update checks.