com.projectkorra.projectkorra.util

Class Updater

java.lang.Object

com.projectkorra.projectkorra.util.Updater

public class Updater
extends java.lang.Object

Updater class that takes an rss feed and checks for updates there
Will only work on xenforo rss feeds

Methods to look for in this class:

• checkUpdate() called in plugin.onEnable() to display update message in log
• getCurrentVersion() to get the version of the plugin
• getUpdateVersion() to get the update version
• updateAvailable() to check if theres an update

Author:

Jacklin213

Constructor Summary

Constructors

Constructor and Description
Updater(org.bukkit.plugin.Plugin plugin, java.lang.String URL) Creates a new instance of Updater.

Method Summary

Modifier and Type	Method and Description
void	checkUpdate() Logs and update message in console.
java.lang.String	getCurrentVersion() Gets the current plugin version from the plugin.yml.
java.lang.String	getUpdateVersion() Gets latest plugin version.
java.net.URL	getUrl() Gets the connected URL object.
boolean	updateAvailable() Checks to see if an update is available.

Methods inherited from class java.lang.Object

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

Constructor Detail

Updater

public Updater(org.bukkit.plugin.Plugin plugin,
               java.lang.String URL)

Creates a new instance of Updater. This constructor should only be called inside of plugin.onEnable() or called after the plugin is loaded.

This constructor should NEVER be called to initiate a field. If called to initiate a field, Updater will throw NullPointerExceptions

Parameters:

plugin - Plugin to check updates for

URL - RSS feed URL link to check for updates on.

Method Detail

checkUpdate

public void checkUpdate()

Logs and update message in console. Displays different messages dependent on updateAvailable()

getUpdateVersion

public java.lang.String getUpdateVersion()

Gets latest plugin version.

Returns:

Latest plugin version, or null if it cannot connect

updateAvailable

public boolean updateAvailable()

Checks to see if an update is available.

Returns:

true If there is an update

getUrl

public java.net.URL getUrl()

Gets the connected URL object.

Returns:

The URL object

getCurrentVersion

public java.lang.String getCurrentVersion()

Gets the current plugin version from the plugin.yml.

Returns:

The current plugin version