com.comphenix.protocol.error

Class DetailedErrorReporter

java.lang.Object

com.comphenix.protocol.error.DetailedErrorReporter

All Implemented Interfaces:

ErrorReporter

public class DetailedErrorReporter
extends java.lang.Object
implements ErrorReporter

Internal class used to handle exceptions.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	apacheCommonsMissing
static int	DEFAULT_MAX_ERROR_COUNT
static java.lang.String	DEFAULT_PREFIX
static java.lang.String	DEFAULT_SUPPORT_URL
static java.lang.String	ERROR_PERMISSION
protected java.util.Map<java.lang.String,java.lang.Object>	globalParameters
protected java.util.concurrent.atomic.AtomicInteger	internalErrorCount
protected java.util.logging.Logger	logger
protected int	maxErrorCount
static java.lang.String	PLUGIN_NAME
protected java.lang.ref.WeakReference<org.bukkit.plugin.Plugin>	pluginReference
protected java.lang.String	prefix
static java.lang.String	SECOND_LEVEL_PREFIX
protected java.lang.String	supportURL

Constructor Summary

Constructors

Constructor and Description
DetailedErrorReporter(org.bukkit.plugin.Plugin plugin) Create a default error reporting system.
DetailedErrorReporter(org.bukkit.plugin.Plugin plugin, java.lang.String prefix, java.lang.String supportURL) Create a central error reporting system.
DetailedErrorReporter(org.bukkit.plugin.Plugin plugin, java.lang.String prefix, java.lang.String supportURL, int maxErrorCount, java.util.logging.Logger logger) Create a central error reporting system.

Method Summary

Methods

Modifier and Type	Method and Description
void	addGlobalParameter(java.lang.String key, java.lang.Object value) Adds the given global parameter.
protected java.lang.String	addPrefix(java.lang.String text, java.lang.String prefix) Adds the given prefix to every line in the text.
void	clearGlobalParameters()
int	getErrorCount()
java.lang.Object	getGlobalParameter(java.lang.String key)
java.util.logging.Logger	getLogger()
int	getMaxErrorCount()
java.lang.String	getPrefix()
protected java.lang.String	getStringDescription(java.lang.Object value)
java.lang.String	getSupportURL()
java.util.Set<java.lang.String>	globalParameters()
protected boolean	isSimpleType(java.lang.Object test) Determine if the given object is a wrapper for a primitive/simple type or not.
void	reportDetailed(java.lang.Object sender, java.lang.String message, java.lang.Throwable error, java.lang.Object... parameters) Prints a detailed error report about an unhandled exception.
void	reportMinimal(org.bukkit.plugin.Plugin sender, java.lang.String methodName, java.lang.Throwable error) Prints a small minimal error report about an exception from another plugin.
void	reportMinimal(org.bukkit.plugin.Plugin sender, java.lang.String methodName, java.lang.Throwable error, java.lang.Object... parameters) Prints a small minimal error report about an exception from another plugin.
boolean	reportMinimalNoSpam(org.bukkit.plugin.Plugin sender, java.lang.String methodName, java.lang.Throwable error)
void	reportWarning(java.lang.Object sender, java.lang.String message) Prints a warning message from the current plugin.
void	reportWarning(java.lang.Object sender, java.lang.String message, java.lang.Throwable error) Prints a warning message from the current plugin.
void	setErrorCount(int errorCount)
void	setLogger(java.util.logging.Logger logger)
void	setMaxErrorCount(int maxErrorCount)
void	setPrefix(java.lang.String prefix)
void	setSupportURL(java.lang.String supportURL)

Methods inherited from class java.lang.Object

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

Field Detail

SECOND_LEVEL_PREFIX

public static final java.lang.String SECOND_LEVEL_PREFIX

See Also:

Constant Field Values

DEFAULT_PREFIX

public static final java.lang.String DEFAULT_PREFIX

See Also:

Constant Field Values

DEFAULT_SUPPORT_URL

public static final java.lang.String DEFAULT_SUPPORT_URL

See Also:

Constant Field Values

PLUGIN_NAME

public static final java.lang.String PLUGIN_NAME

See Also:

Constant Field Values

ERROR_PERMISSION

public static final java.lang.String ERROR_PERMISSION

See Also:

Constant Field Values

DEFAULT_MAX_ERROR_COUNT

public static final int DEFAULT_MAX_ERROR_COUNT

See Also:

Constant Field Values

prefix

protected java.lang.String prefix

supportURL

protected java.lang.String supportURL

internalErrorCount

protected java.util.concurrent.atomic.AtomicInteger internalErrorCount

maxErrorCount

protected int maxErrorCount

logger

protected java.util.logging.Logger logger

pluginReference

protected java.lang.ref.WeakReference<org.bukkit.plugin.Plugin> pluginReference

apacheCommonsMissing

protected boolean apacheCommonsMissing

globalParameters

protected java.util.Map<java.lang.String,java.lang.Object> globalParameters

Constructor Detail

DetailedErrorReporter

public DetailedErrorReporter(org.bukkit.plugin.Plugin plugin)

Create a default error reporting system.

DetailedErrorReporter

public DetailedErrorReporter(org.bukkit.plugin.Plugin plugin,
                     java.lang.String prefix,
                     java.lang.String supportURL)

Create a central error reporting system.

Parameters:

plugin - - the plugin owner.

prefix - - default line prefix.

supportURL - - URL to report the error.

DetailedErrorReporter

public DetailedErrorReporter(org.bukkit.plugin.Plugin plugin,
                     java.lang.String prefix,
                     java.lang.String supportURL,
                     int maxErrorCount,
                     java.util.logging.Logger logger)

Create a central error reporting system.

Parameters:

plugin - - the plugin owner.

prefix - - default line prefix.

supportURL - - URL to report the error.

maxErrorCount - - number of errors to print before giving up.

logger - - current logger.

Method Detail

reportMinimal

public void reportMinimal(org.bukkit.plugin.Plugin sender,
                 java.lang.String methodName,
                 java.lang.Throwable error,
                 java.lang.Object... parameters)

Description copied from interface: ErrorReporter

Prints a small minimal error report about an exception from another plugin.

Specified by:

reportMinimal in interface ErrorReporter

Parameters:

sender - - the other plugin.

methodName - - name of the caller method.

error - - the exception itself.

parameters - - any relevant parameters to print.

reportMinimal

public void reportMinimal(org.bukkit.plugin.Plugin sender,
                 java.lang.String methodName,
                 java.lang.Throwable error)

Description copied from interface: ErrorReporter

Prints a small minimal error report about an exception from another plugin.

Specified by:

reportMinimal in interface ErrorReporter

Parameters:

sender - - the other plugin.

methodName - - name of the caller method.

error - - the exception itself.

reportMinimalNoSpam

public boolean reportMinimalNoSpam(org.bukkit.plugin.Plugin sender,
                          java.lang.String methodName,
                          java.lang.Throwable error)

reportWarning

public void reportWarning(java.lang.Object sender,
                 java.lang.String message)

Description copied from interface: ErrorReporter

Prints a warning message from the current plugin.

Specified by:

reportWarning in interface ErrorReporter

Parameters:

sender - - the object containing the caller method.

message - - error message.

reportWarning

public void reportWarning(java.lang.Object sender,
                 java.lang.String message,
                 java.lang.Throwable error)

Description copied from interface: ErrorReporter

Prints a warning message from the current plugin.

Specified by:

reportWarning in interface ErrorReporter

Parameters:

sender - - the object containing the caller method.

message - - error message.

error - - the exception that was thrown.

reportDetailed

public void reportDetailed(java.lang.Object sender,
                  java.lang.String message,
                  java.lang.Throwable error,
                  java.lang.Object... parameters)

Description copied from interface: ErrorReporter

Prints a detailed error report about an unhandled exception.

Specified by:

reportDetailed in interface ErrorReporter

Parameters:

sender - - the object containing the caller method.

message - - an error message to include.

error - - the exception that was thrown in the caller method.

parameters - - parameters from the caller method.

addPrefix

protected java.lang.String addPrefix(java.lang.String text,
                         java.lang.String prefix)

Adds the given prefix to every line in the text.

Parameters:

text - - text to modify.

prefix - - prefix added to every line in the text.

Returns:

The modified text.

getStringDescription

protected java.lang.String getStringDescription(java.lang.Object value)

isSimpleType

protected boolean isSimpleType(java.lang.Object test)

Determine if the given object is a wrapper for a primitive/simple type or not.

Parameters:

test - - the object to test.

Returns:

TRUE if this object is simple enough to simply be printed, FALSE othewise.

getErrorCount

public int getErrorCount()

setErrorCount

public void setErrorCount(int errorCount)

getMaxErrorCount

public int getMaxErrorCount()

setMaxErrorCount

public void setMaxErrorCount(int maxErrorCount)

addGlobalParameter

public void addGlobalParameter(java.lang.String key,
                      java.lang.Object value)

Adds the given global parameter. It will be included in every error report.

Parameters:

key - - name of parameter.

value - - the global parameter itself.

getGlobalParameter

public java.lang.Object getGlobalParameter(java.lang.String key)

clearGlobalParameters

public void clearGlobalParameters()

globalParameters

public java.util.Set<java.lang.String> globalParameters()

getSupportURL

public java.lang.String getSupportURL()

setSupportURL

public void setSupportURL(java.lang.String supportURL)

getPrefix

public java.lang.String getPrefix()

setPrefix

public void setPrefix(java.lang.String prefix)

getLogger

public java.util.logging.Logger getLogger()

setLogger

public void setLogger(java.util.logging.Logger logger)