com.comphenix.protocol

Class ProtocolLibrary

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

com.comphenix.protocol.ProtocolLibrary

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin

public class ProtocolLibrary
extends org.bukkit.plugin.java.JavaPlugin

The main entry point for ProtocolLib.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MAXIMUM_MINECRAFT_VERSION The maximum version ProtocolLib has been tested with,
static java.lang.String	MINECRAFT_LAST_RELEASE_DATE The date (with ISO 8601 or YYYY-MM-DD) when the most recent version was released.
static java.lang.String	MINIMUM_MINECRAFT_VERSION The minimum version ProtocolLib has been tested with.
static ReportType	REPORT_CANNOT_CREATE_TIMEOUT_TASK
static ReportType	REPORT_CANNOT_DELETE_CONFIG
static ReportType	REPORT_CANNOT_DETECT_CONFLICTING_PLUGINS
static ReportType	REPORT_CANNOT_LOAD_CONFIG
static ReportType	REPORT_CANNOT_PARSE_INJECTION_METHOD
static ReportType	REPORT_CANNOT_PARSE_MINECRAFT_VERSION
static ReportType	REPORT_CANNOT_REGISTER_COMMAND
static ReportType	REPORT_CANNOT_UPDATE_PLUGIN
static ReportType	REPORT_METRICS_GENERIC_ERROR
static ReportType	REPORT_METRICS_IO_ERROR
static ReportType	REPORT_PLUGIN_ENABLE_ERROR
static ReportType	REPORT_PLUGIN_LOAD_ERROR

Constructor Summary

Constructors

Constructor and Description
ProtocolLibrary()

Method Summary

Methods

Modifier and Type	Method and Description
static ProtocolConfig	getConfiguration() Retrieve the current strongly typed configuration.
static ErrorReporter	getErrorReporter() Retrieve the current error reporter.
static com.google.common.util.concurrent.ListeningScheduledExecutorService	getExecutorAsync() Retrieve an executor service for performing asynchronous tasks on the behalf of ProtocolLib.
static com.google.common.util.concurrent.ListeningScheduledExecutorService	getExecutorSync() Retrieve an executor service for performing synchronous tasks (main thread) on the behalf of ProtocolLib.
static ProtocolManager	getProtocolManager() Retrieves the packet protocol manager.
Statistics	getStatistics() Retrieve the metrics instance used to measure users of this library.
void	onDisable()
void	onEnable()
void	onLoad()
void	reloadConfig()

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDatabase, getDatabaseClasses, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPluginLoader, getResource, getServer, initialize, installDDL, isEnabled, isInitialized, isNaggable, onCommand, onTabComplete, removeDDL, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString

Methods inherited from class org.bukkit.plugin.PluginBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

REPORT_CANNOT_LOAD_CONFIG

public static final ReportType REPORT_CANNOT_LOAD_CONFIG

REPORT_CANNOT_DELETE_CONFIG

public static final ReportType REPORT_CANNOT_DELETE_CONFIG

REPORT_CANNOT_PARSE_INJECTION_METHOD

public static final ReportType REPORT_CANNOT_PARSE_INJECTION_METHOD

REPORT_PLUGIN_LOAD_ERROR

public static final ReportType REPORT_PLUGIN_LOAD_ERROR

REPORT_PLUGIN_ENABLE_ERROR

public static final ReportType REPORT_PLUGIN_ENABLE_ERROR

REPORT_METRICS_IO_ERROR

public static final ReportType REPORT_METRICS_IO_ERROR

REPORT_METRICS_GENERIC_ERROR

public static final ReportType REPORT_METRICS_GENERIC_ERROR

REPORT_CANNOT_PARSE_MINECRAFT_VERSION

public static final ReportType REPORT_CANNOT_PARSE_MINECRAFT_VERSION

REPORT_CANNOT_DETECT_CONFLICTING_PLUGINS

public static final ReportType REPORT_CANNOT_DETECT_CONFLICTING_PLUGINS

REPORT_CANNOT_REGISTER_COMMAND

public static final ReportType REPORT_CANNOT_REGISTER_COMMAND

REPORT_CANNOT_CREATE_TIMEOUT_TASK

public static final ReportType REPORT_CANNOT_CREATE_TIMEOUT_TASK

REPORT_CANNOT_UPDATE_PLUGIN

public static final ReportType REPORT_CANNOT_UPDATE_PLUGIN

MINIMUM_MINECRAFT_VERSION

public static final java.lang.String MINIMUM_MINECRAFT_VERSION

The minimum version ProtocolLib has been tested with.

See Also:

Constant Field Values

MAXIMUM_MINECRAFT_VERSION

public static final java.lang.String MAXIMUM_MINECRAFT_VERSION

The maximum version ProtocolLib has been tested with,

See Also:

Constant Field Values

MINECRAFT_LAST_RELEASE_DATE

public static final java.lang.String MINECRAFT_LAST_RELEASE_DATE

The date (with ISO 8601 or YYYY-MM-DD) when the most recent version was released.

See Also:

Constant Field Values

Constructor Detail

ProtocolLibrary

public ProtocolLibrary()

Method Detail

onLoad

public void onLoad()

Specified by:

onLoad in interface org.bukkit.plugin.Plugin

Overrides:

onLoad in class org.bukkit.plugin.java.JavaPlugin

reloadConfig

public void reloadConfig()

Specified by:

reloadConfig in interface org.bukkit.plugin.Plugin

Overrides:

reloadConfig in class org.bukkit.plugin.java.JavaPlugin

onEnable

public void onEnable()

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

onEnable in class org.bukkit.plugin.java.JavaPlugin

onDisable

public void onDisable()

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

onDisable in class org.bukkit.plugin.java.JavaPlugin

getErrorReporter

public static ErrorReporter getErrorReporter()

Retrieve the current error reporter.

This is guaranteed to not be NULL in 2.5.0 and later.

Returns:

Current error reporter.

getConfiguration

public static ProtocolConfig getConfiguration()

Retrieve the current strongly typed configuration.

Returns:

The configuration, or NULL if ProtocolLib hasn't loaded yet.

getProtocolManager

public static ProtocolManager getProtocolManager()

Retrieves the packet protocol manager.

Returns:

Packet protocol manager, or NULL if it has been disabled.

getStatistics

public Statistics getStatistics()

Retrieve the metrics instance used to measure users of this library.

Note that this method may return NULL when the server is reloading or shutting down. It is also NULL if metrics has been disabled.

Returns:

Metrics instance container.

getExecutorAsync

public static com.google.common.util.concurrent.ListeningScheduledExecutorService getExecutorAsync()

Retrieve an executor service for performing asynchronous tasks on the behalf of ProtocolLib.

Note that this service is NULL if ProtocolLib has not been initialized yet.

Returns:

The executor service, or NULL.

getExecutorSync

public static com.google.common.util.concurrent.ListeningScheduledExecutorService getExecutorSync()

Retrieve an executor service for performing synchronous tasks (main thread) on the behalf of ProtocolLib.

Note that this service is NULL if ProtocolLib has not been initialized yet.

Returns:

The executor service, or NULL.