com.jeff_media.updatechecker

Enum UpdateCheckSource

java.lang.Object

java.lang.Enum<UpdateCheckSource>

com.jeff_media.updatechecker.UpdateCheckSource

All Implemented Interfaces:

Serializable, Comparable<UpdateCheckSource>

public enum UpdateCheckSource
extends Enum<UpdateCheckSource>

Represents the source from where to fetch update information.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM_URL Custom link on where to fetch update checking information.
GITHUB_RELEASE_TAG GitHub Releases API.
HANGAR Hangar API.
POLYMART Polymart API.
SPIGET Spiget API.
SPIGOT SpigotMC API.

Method Summary

Modifier and Type	Method and Description
static UpdateCheckSource	valueOf(String name) Returns the enum constant of this type with the specified name.
static UpdateCheckSource[]	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

SPIGOT

public static final UpdateCheckSource SPIGOT

SpigotMC API. Trustworthy, but slow. Requires the SpigotMC resource ID (the number at the end of your plugin's SpigotMC URL) as parameter in UpdateChecker(JavaPlugin, UpdateCheckSource, String).

POLYMART

public static final UpdateCheckSource POLYMART

Polymart API. Trustworthy, but slow. Requires the Polymart resource ID (the number at the end of your plugin's Polymart URL) as parameter in UpdateChecker(JavaPlugin, UpdateCheckSource, String).

SPIGET

public static final UpdateCheckSource SPIGET

Spiget API. Not official, but faster than SpigotMC API. Requires the SpigotMC resource ID (the number at the end of your plugin's SpigotMC URL) as parameter in UpdateChecker(JavaPlugin, UpdateCheckSource, String).

GITHUB_RELEASE_TAG

public static final UpdateCheckSource GITHUB_RELEASE_TAG

GitHub Releases API. Requires your repository in the format "UserName/RepositoryName" (for example: "JEFF-Media-GbR/ChestSort") as parameter in UpdateChecker(JavaPlugin, UpdateCheckSource, String). It will use the latest release's tag string.

HANGAR

public static final UpdateCheckSource HANGAR

Hangar API. Requires your resource in the format "UserName/ProjectName/ReleaseChannel" (for example: "JEFF-Media-GbR/ChestSort/Release") as parameter in UpdateChecker(JavaPlugin, UpdateCheckSource, String). It will use the latest release's version string according to that release channel.

CUSTOM_URL

public static final UpdateCheckSource CUSTOM_URL

Custom link on where to fetch update checking information. Requires an HTTP or HTTPS URL as parameter in UpdateChecker(JavaPlugin, UpdateCheckSource, String). The linked file must be a plaintext file containing only for the latest version string.

Method Detail

values

public static UpdateCheckSource[] 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 (UpdateCheckSource c : UpdateCheckSource.values())
    System.out.println(c);

Returns:

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

valueOf

public static UpdateCheckSource 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