io.github.bedwarsrel.updater

Enum PluginUpdater.UpdateResult

java.lang.Object

java.lang.Enum<PluginUpdater.UpdateResult>

io.github.bedwarsrel.updater.PluginUpdater.UpdateResult

All Implemented Interfaces:

Serializable, Comparable<PluginUpdater.UpdateResult>

Enclosing class:

PluginUpdater

public static enum PluginUpdater.UpdateResult
extends Enum<PluginUpdater.UpdateResult>

Gives the developer the result of the update process. Can be obtained by called PluginUpdater.getResult()

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED The server administrator has disabled the updating system.
FAIL_APIKEY The server administrator has improperly configured their API key in the configuration.
FAIL_BADID The id provided by the plugin running the updater was invalid and doesn't exist on DBO.
FAIL_DBO For some reason, the updater was unable to contact dev.bukkit.org to download the file.
FAIL_DOWNLOAD The updater found an update, but was unable to download it.
FAIL_NOVERSION When running the version check, the file on DBO did not contain a recognizable version.
NO_UPDATE The updater did not find an update, and nothing was downloaded.
SUCCESS The updater found an update, and has readied it to be loaded the next time the server restarts/reloads.
UPDATE_AVAILABLE The updater found an update, but because of the UpdateType being set to NO_DOWNLOAD, it wasn't downloaded.

Method Summary

Modifier and Type	Method and Description
static PluginUpdater.UpdateResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static PluginUpdater.UpdateResult[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final PluginUpdater.UpdateResult SUCCESS

The updater found an update, and has readied it to be loaded the next time the server restarts/reloads.

NO_UPDATE

public static final PluginUpdater.UpdateResult NO_UPDATE

The updater did not find an update, and nothing was downloaded.

DISABLED

public static final PluginUpdater.UpdateResult DISABLED

The server administrator has disabled the updating system.

FAIL_DOWNLOAD

public static final PluginUpdater.UpdateResult FAIL_DOWNLOAD

The updater found an update, but was unable to download it.

FAIL_DBO

public static final PluginUpdater.UpdateResult FAIL_DBO

For some reason, the updater was unable to contact dev.bukkit.org to download the file.

FAIL_NOVERSION

public static final PluginUpdater.UpdateResult FAIL_NOVERSION

When running the version check, the file on DBO did not contain a recognizable version.

FAIL_BADID

public static final PluginUpdater.UpdateResult FAIL_BADID

The id provided by the plugin running the updater was invalid and doesn't exist on DBO.

FAIL_APIKEY

public static final PluginUpdater.UpdateResult FAIL_APIKEY

The server administrator has improperly configured their API key in the configuration.

UPDATE_AVAILABLE

public static final PluginUpdater.UpdateResult UPDATE_AVAILABLE

The updater found an update, but because of the UpdateType being set to NO_DOWNLOAD, it wasn't downloaded.

Method Detail

values

public static PluginUpdater.UpdateResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PluginUpdater.UpdateResult c : PluginUpdater.UpdateResult.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PluginUpdater.UpdateResult valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null