Index

A B C F G I N O P R S U V
All Classes and Interfaces|All Packages

A

addBukkitVersion() - Method in class com.jeff_media.updatechecker.UserAgentBuilder

Adds the Bukkit version.

addKeyValue(String, String) - Method in class com.jeff_media.updatechecker.UserAgentBuilder

Adds a custom Key/Value string.

addPlaintext(String) - Method in class com.jeff_media.updatechecker.UserAgentBuilder

Adds a custom string.

addPluginNameAndVersion() - Method in class com.jeff_media.updatechecker.UserAgentBuilder

Adds the plugin and version.

addServerVersion() - Method in class com.jeff_media.updatechecker.UserAgentBuilder

Adds the Server version.

addSpigotUserId() - Method in class com.jeff_media.updatechecker.UserAgentBuilder

Returns the Spigot User ID of the user who downloaded the plugin.

addUsingPaidVersion() - Method in class com.jeff_media.updatechecker.UserAgentBuilder

Returns whether this copy of the .jar is a paid plugin downloaded from SpigotMC.org.

B

build() - Method in class com.jeff_media.updatechecker.UserAgentBuilder

Converts this UserAgentBuilder instance to a UserAgent string

C

checkEveryXHours(double) - Method in class com.jeff_media.updatechecker.UpdateChecker

Starts to check every X hours for updates.

checkNow() - Method in class com.jeff_media.updatechecker.UpdateChecker

Checks for updates now and sends the result to the console when notifyRequesters is set to true (default)

checkNow(CommandSender...) - Method in class com.jeff_media.updatechecker.UpdateChecker

Checks for updates now and sends the result to the given list of CommandSenders.

com.jeff_media.updatechecker - package com.jeff_media.updatechecker

Main package. Must be relocated when shading!

CUSTOM_URL - Enum constant in enum com.jeff_media.updatechecker.UpdateCheckSource

Custom link on where to fetch update checking information.

F

FAIL - Enum constant in enum com.jeff_media.updatechecker.UpdateCheckSuccess

G

getAppropriateDownloadLinks() - Method in class com.jeff_media.updatechecker.UpdateChecker

Returns a list of applicable Download links.

getChangelogLink() - Method in class com.jeff_media.updatechecker.UpdateChecker

Returns the changelog link

getDefaultUserAgent() - Static method in class com.jeff_media.updatechecker.UserAgentBuilder

Returns the default User-Agent, consisting of Plugin name and version, Server version and Bukkit version

getDonationLink() - Method in class com.jeff_media.updatechecker.UpdateChecker

Returns the donation link

getHandlerList() - Static method in class com.jeff_media.updatechecker.UpdateCheckEvent

getHandlers() - Method in class com.jeff_media.updatechecker.UpdateCheckEvent

getInstance() - Static method in class com.jeff_media.updatechecker.UpdateChecker

Deprecated.

As of SpigotUpdateChecker 1.4.0, more than one instance can exist at the same time. Keep track of the instances you created yourself.

getLastCheckResult() - Method in class com.jeff_media.updatechecker.UpdateChecker

Returns the last successful UpdateCheckResult

getLatestVersion() - Method in class com.jeff_media.updatechecker.UpdateChecker

Returns the latest version string found by the UpdateChecker, or null if all checks until yet have failed.

getLatestVersion() - Method in class com.jeff_media.updatechecker.UpdateCheckEvent

Returns the latest version string found by the UpdateChecker, or null if all previous checks have failed.

getLatestVersionString() - Method in interface com.jeff_media.updatechecker.VersionSupplier

Returns the latest version of your plugin.

getNameFreeVersion() - Method in class com.jeff_media.updatechecker.UpdateChecker

Returns the name/suffix of the free plugin version

getNamePaidVersion() - Method in class com.jeff_media.updatechecker.UpdateChecker

Returns the name/suffix of the paid plugin version

getNotifyPermission() - Method in class com.jeff_media.updatechecker.UpdateChecker

Returns the permission required to receive UpdateChecker messages on join

getOnFail() - Method in class com.jeff_media.updatechecker.UpdateChecker

Gets the task that will run when/after the update check fails.

getOnSuccess() - Method in class com.jeff_media.updatechecker.UpdateChecker

Gets the task that will run when/after the update check succeeds.

getPlugin() - Method in class com.jeff_media.updatechecker.UpdateChecker

Gets the plugin that instantiated this UpdateChecker instance

getRequesters() - Method in class com.jeff_media.updatechecker.UpdateCheckEvent

Gets an array of all CommandSenders who have requested this update check.

getResult() - Method in class com.jeff_media.updatechecker.UpdateCheckEvent

Gets the result, i.e. whether a new version is available or not.

getSpigotUserId() - Method in class com.jeff_media.updatechecker.UpdateChecker

Gets the Spigot User ID of the user who downloaded the plugin if it's a premium plugin, otherwise "%%__USER__%%"

getSuccess() - Method in class com.jeff_media.updatechecker.UpdateCheckEvent

Checks whether the update checking attempt was successful or failed.

getSupportLink() - Method in class com.jeff_media.updatechecker.UpdateChecker

Returns the support link

getUsedVersion() - Method in class com.jeff_media.updatechecker.UpdateChecker

Gets the version string of the currently used plugin version

getUsedVersion() - Method in class com.jeff_media.updatechecker.UpdateCheckEvent

Gets the version string of the currently used plugin version.

GITHUB_RELEASE_TAG - Enum constant in enum com.jeff_media.updatechecker.UpdateCheckSource

GitHub Releases API.

I

init(JavaPlugin, int) - Static method in class com.jeff_media.updatechecker.UpdateChecker

Deprecated.

Use UpdateChecker(JavaPlugin, UpdateCheckSource, String) instead.

init(JavaPlugin, String) - Static method in class com.jeff_media.updatechecker.UpdateChecker

Deprecated.

Use UpdateChecker(JavaPlugin, UpdateCheckSource, String) instead.

isCheckedAtLeastOnce() - Method in class com.jeff_media.updatechecker.UpdateChecker

Checks whether the update checker already ran.

isColoredConsoleOutput() - Method in class com.jeff_media.updatechecker.UpdateChecker

Returns whether colored console output is enabled

isNotifyOpsOnJoin() - Method in class com.jeff_media.updatechecker.UpdateChecker

Returns whether OPs will be notified on join when a new version is available

isNotifyRequesters() - Method in class com.jeff_media.updatechecker.UpdateChecker

Gets whether the given CommandSenders will be informed about UpdateChecker results

isOtherVersionNewer(String, String) - Static method in class com.jeff_media.updatechecker.UpdateChecker

Checks whether one version is really newer than another according to the semantic versioning scheme, including letters.

isSuppressUpToDateMessage() - Method in class com.jeff_media.updatechecker.UpdateChecker

Returns whether the message "You are using the latest version of " will be suppressed.

isUsingLatestVersion() - Method in class com.jeff_media.updatechecker.UpdateChecker

Checks whether the latest found version of the plugin is being used.

isUsingPaidVersion() - Method in class com.jeff_media.updatechecker.UpdateChecker

Returns whether the paid version of the plugin is installed.

N

NEW_VERSION_AVAILABLE - Enum constant in enum com.jeff_media.updatechecker.UpdateCheckResult

Result when a new version is available

O

onFail(BiConsumer<CommandSender[], Exception>) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets a task that will run when/after the update check has failed.

onSuccess(BiConsumer<CommandSender[], String>) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets a task that will run when/after the update check has succeeded.

P

POLYMART - Enum constant in enum com.jeff_media.updatechecker.UpdateCheckSource

Polymart API.

R

RUNNING_LATEST_VERSION - Enum constant in enum com.jeff_media.updatechecker.UpdateCheckResult

Result when the plugin is already the latest version

S

setChangelogLink(int) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets a link to your plugin's changelog generated from your plugin's SpigotMC/Polymart Resource ID

setChangelogLink(String) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets a link to your plugin's changelog.

setColoredConsoleOutput(boolean) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets whether or not the used and latest version will be displayed in color in the console

setDonationLink(String) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets a link to your plugin's donation website

setDownloadLink(int) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets the download link for your plugin generated from your plugin's SpigotMC/Polymart Resource ID.

setDownloadLink(String) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets the download link for your plugin.

setFreeDownloadLink(int) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets the download link for the free version of your plugin generated from your plugin's SpigotMC/Polymart Resource ID.

setFreeDownloadLink(String) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets the download link for the free version of your plugin.

setNameFreeVersion(String) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets the name/suffix for the free version's name.

setNamePaidVersion(String) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets the name/suffix for the paid version's name.

setNotifyByPermissionOnJoin(String) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets the permission needed to be informed about UpdateChecker results on join.

setNotifyOpsOnJoin(boolean) - Method in class com.jeff_media.updatechecker.UpdateChecker

Whether or not to inform OPs on join when there is a new version available.

setNotifyRequesters(boolean) - Method in class com.jeff_media.updatechecker.UpdateChecker

Whether or not CommandSenders who request an update check will be notified of the result.

setPaidDownloadLink(int) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets the download link for the paid version of your plugin generated from your plugin's SpigotMC/Polymart Resource ID.

setPaidDownloadLink(String) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets the download link for the paid version of your plugin.

setRequesters(CommandSender...) - Method in class com.jeff_media.updatechecker.UpdateCheckEvent

Sets the CommandSenders who requested this update check.

setSupportLink(String) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets a link to your plugin's support channel.

setTimeout(int) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets the timeout for the HTTP(S) connection in milliseconds. 0 = use Java's default value

setUsedVersion(String) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets the version string of the currently used plugin version.

setUserAgent(UserAgentBuilder) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets the UserAgent string using a UserAgentBuilder

setUserAgent(String) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets the UserAgent string using plain text

setUsingPaidVersion(boolean) - Method in class com.jeff_media.updatechecker.UpdateChecker

Tells the UpdateChecker whether the server already uses the paid version of your plugin.

SPIGET - Enum constant in enum com.jeff_media.updatechecker.UpdateCheckSource

Spiget API.

SPIGOT - Enum constant in enum com.jeff_media.updatechecker.UpdateCheckSource

SpigotMC API.

stop() - Method in class com.jeff_media.updatechecker.UpdateChecker

Stops the scheduled update checks.

SUCCESS - Enum constant in enum com.jeff_media.updatechecker.UpdateCheckSuccess

suppressUpToDateMessage(boolean) - Method in class com.jeff_media.updatechecker.UpdateChecker

Sets whether the message "You are using the latest version of " should be suppressed.

U

UNKNOWN - Enum constant in enum com.jeff_media.updatechecker.UpdateCheckResult

Result when the update check failed, or the version could not be compared

UpdateChecker - Class in com.jeff_media.updatechecker

Main class. Automatically checks for updates.

UpdateChecker(JavaPlugin, UpdateCheckSource, String) - Constructor for class com.jeff_media.updatechecker.UpdateChecker

Initializes an UpdateChecker instance.

UpdateChecker(JavaPlugin, VersionSupplier) - Constructor for class com.jeff_media.updatechecker.UpdateChecker

Initializes an UpdateChecker instance with a custom VersionSupplier.

UpdateCheckEvent - Class in com.jeff_media.updatechecker

This event is called whenever an update check is finished.

UpdateCheckEvent(UpdateCheckSuccess) - Constructor for class com.jeff_media.updatechecker.UpdateCheckEvent

UpdateCheckResult - Enum in com.jeff_media.updatechecker

Represents whether a new version is available or not

UpdateCheckSource - Enum in com.jeff_media.updatechecker

Represents the source from where to fetch update information.

UpdateCheckSuccess - Enum in com.jeff_media.updatechecker

Represents whether the update check was successful

UserAgentBuilder - Class in com.jeff_media.updatechecker

Creates a User-Agent string.

UserAgentBuilder() - Constructor for class com.jeff_media.updatechecker.UserAgentBuilder

V

valueOf(String) - Static method in enum com.jeff_media.updatechecker.UpdateCheckResult

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.jeff_media.updatechecker.UpdateCheckSource

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.jeff_media.updatechecker.UpdateCheckSuccess

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.jeff_media.updatechecker.UpdateCheckResult

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

values() - Static method in enum com.jeff_media.updatechecker.UpdateCheckSource

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

values() - Static method in enum com.jeff_media.updatechecker.UpdateCheckSuccess

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

VersionSupplier - Interface in com.jeff_media.updatechecker

Used to supply the latest version of your plugin in conjunction with UpdateChecker(JavaPlugin, VersionSupplier)

A B C F G I N O P R S U V
All Classes and Interfaces|All Packages