com.comphenix.protocol.metrics

Enum Updater.UpdateResult

java.lang.Object

java.lang.Enum<Updater.UpdateResult>

com.comphenix.protocol.metrics.Updater.UpdateResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Updater.UpdateResult>

Enclosing class:

Updater

public static enum Updater.UpdateResult
extends java.lang.Enum<Updater.UpdateResult>

Gives the dev the result of the update process. Can be obtained by called 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 the a version in the format 'vVersion' such as 'v1.0'.
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

Methods

Modifier and Type	Method and Description
java.lang.String	toString()
static Updater.UpdateResult	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Updater.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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final Updater.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 Updater.UpdateResult NO_UPDATE

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

DISABLED

public static final Updater.UpdateResult DISABLED

The server administrator has disabled the updating system

FAIL_DOWNLOAD

public static final Updater.UpdateResult FAIL_DOWNLOAD

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

FAIL_DBO

public static final Updater.UpdateResult FAIL_DBO

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

FAIL_NOVERSION

public static final Updater.UpdateResult FAIL_NOVERSION

When running the version check, the file on DBO did not contain the a version in the format 'vVersion' such as 'v1.0'.

FAIL_BADID

public static final Updater.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 Updater.UpdateResult FAIL_APIKEY

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

UPDATE_AVAILABLE

public static final Updater.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 Updater.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 (Updater.UpdateResult c : Updater.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 Updater.UpdateResult valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Updater.UpdateResult>