com.comphenix.xp.metrics

Class AutoUpdate

java.lang.Object

com.comphenix.xp.metrics.AutoUpdate

All Implemented Interfaces:

java.lang.Runnable, org.bukkit.event.Listener

public class AutoUpdate
extends java.lang.Object
implements java.lang.Runnable, org.bukkit.event.Listener

Mod: ExperienceMod

Version:

1.0-Comphenix

Author:

V10lator

Constructor Summary

Constructors

Constructor and Description
AutoUpdate(org.bukkit.plugin.Plugin plugin) This will use your main configuration (config.yml).
AutoUpdate(org.bukkit.plugin.Plugin plugin, org.bukkit.configuration.Configuration config) This will use a custom configuration.

Method Summary

Methods

Modifier and Type	Method and Description
void	adminJoin(org.bukkit.event.player.PlayerJoinEvent event) This is internal stuff.
boolean	isDebug()
void	resetConfig() This will overwrite the pre-saved configuration.
boolean	restartMainTask() Use this to restart the main task.
void	run() This is internal stuff.
void	setConfig(org.bukkit.configuration.Configuration config) This will overwrite the pre-saved configuration.
void	setDebug(boolean debug) Use this to enable/disable debugging mode at runtime.
void	updateCmd(org.bukkit.event.player.PlayerCommandPreprocessEvent event) This is internal stuff.
boolean	updatePlugin(org.bukkit.command.CommandSender sender) Called by a player or the console to initiate updates.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoUpdate

public AutoUpdate(org.bukkit.plugin.Plugin plugin)
           throws java.io.FileNotFoundException

This will use your main configuration (config.yml). Use this in onEnable().

Parameters:

plugin - The instance of your plugins main class.

Throws:

java.io.FileNotFoundException - - configuration file could not be found.

AutoUpdate

public AutoUpdate(org.bukkit.plugin.Plugin plugin,
          org.bukkit.configuration.Configuration config)
           throws java.io.FileNotFoundException

This will use a custom configuration. Use this in onEnable().

Parameters:

plugin - The instance of your plugins main class.

config - The configuration to use.

Throws:

java.io.FileNotFoundException - - configuration file could not be found.

Method Detail

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)

Use this to enable/disable debugging mode at runtime.

Parameters:

debug - True if you want to enable it, false otherwise.

restartMainTask

public boolean restartMainTask()

Use this to restart the main task. This is useful after scheduler.cancelTasks(plugin); for example.

resetConfig

public void resetConfig()
                 throws java.io.FileNotFoundException

This will overwrite the pre-saved configuration. use this after reloadConfig(), for example. This will use your main configuration (config.yml). This will call restartMainTask() internally.

Throws:

java.io.FileNotFoundException

setConfig

public void setConfig(org.bukkit.configuration.Configuration config)
               throws java.io.FileNotFoundException

This will overwrite the pre-saved configuration. use this after config.load(file), for example. This will use a custom configuration. This will call restartMainTask() internally.

Parameters:

config - The new configuration to use.

Throws:

java.io.FileNotFoundException

run

public void run()

This is internal stuff. Don't call this directly!

Specified by:

run in interface java.lang.Runnable

adminJoin

public void adminJoin(org.bukkit.event.player.PlayerJoinEvent event)

This is internal stuff. Don't call this directly!

updateCmd

public void updateCmd(org.bukkit.event.player.PlayerCommandPreprocessEvent event)

This is internal stuff. Don't call this directly!

updatePlugin

public boolean updatePlugin(org.bukkit.command.CommandSender sender)

Called by a player or the console to initiate updates.

Note that the return value only indicates that the update request was accepted and the download process is scheduled to be executed. The update itself may still fail.

Parameters:

sender - - the player or console that is attempting to initiate an update.

Returns:

TRUE if the update was initiated and the download process has begun, FALSE otherwise.