de.pheasn.pluginupdater

Class Updater.Builder

java.lang.Object

de.pheasn.pluginupdater.Updater.Builder

Enclosing class:

Updater

public abstract static class Updater.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract Updater.Builder	apiKey(String apiKey) Sets the API-Key.
Updater	build() Returns an instance of the Updater class.
abstract Updater.Builder	interval(long interval) Sets the update check interval in minutes.
abstract Updater.Builder	plugin(Updatable plugin) Sets the plugin which must implement the Updatable interface.
abstract Updater.Builder	pluginId(int id) Sets the Bukkit plugin ID.
abstract Updater.Builder	releaseChannel(ReleaseChannel channel) Sets the desired release channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

releaseChannel

public abstract Updater.Builder releaseChannel(ReleaseChannel channel)

Sets the desired release channel. Default: STABLE

Parameters:

channel - the ReleaseChannel

Returns:

this Builder

plugin

public abstract Updater.Builder plugin(Updatable plugin)

Sets the plugin which must implement the Updatable interface.

Parameters:

plugin - the plugin

Returns:

this Builder

pluginId

public abstract Updater.Builder pluginId(int id)

Sets the Bukkit plugin ID.

Parameters:

id - the ID

Returns:

this Builder

interval

public abstract Updater.Builder interval(long interval)

Sets the update check interval in minutes.

Parameters:

interval - the interval in minutes. Must be greater or equal 5 minutes.

Returns:

this Builder

apiKey

@Nullable
public abstract Updater.Builder apiKey(String apiKey)

Sets the API-Key. Every server owner can obtain his Bukkit API-Key on bukkit.org. Default: null

Parameters:

apiKey - the API key

Returns:

this Builder

build

public Updater build()

Returns an instance of the Updater class.

Returns:

the Updater