com.codelanx.codelanxlib.logging

Class Debugger

java.lang.Object

com.codelanx.codelanxlib.logging.Debugger

public final class Debugger
extends Object

Provides toggleable logging supporting for debug statements and error reporting to a webservice for easy bugfixing. Will find unreported errors as well and submit them. Note that this class is provided as a utility, it should not be used as a substitute for general logging statements that are always available. Use the Logging class instead.

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Debugger.ExceptionHandler Attachable Handler used to catch any exceptions that are logged directly to a plugin's Logger

Method Summary

Modifier and Type	Method and Description
static void	error(Throwable error, String message, Object... args) Prints to the Debugging Logger at Level.SEVERE if toggleOutput(boolean) is set to true.
static void	hideErrors(boolean hide) Sets whether or not calls to error(Throwable, String, Object...) will print errors.
static void	hookBukkit() Hooks into Bukkit's plugin system and adds a handler to all plugin loggers to allow catching unreported exceptions.
static void	print(Level level, String format, Object... args) Prints to the Debugging Logger if toggleOutput(boolean) is set to true
static void	print(String format, Object... args) Prints to the Debugging Logger at Level.INFO if toggleOutput(boolean) is set to true
static void	setReportingURL(String url) Sets the URL to send a JSON payload of server information to as well as any other relevant information for when a stack trace occurs.
static void	toggleOutput(boolean output) Sets whether or not to actually output any calls from your plugin to the Debugger.

Methods inherited from class java.lang.Object

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

Method Detail

hookBukkit

public static void hookBukkit()

Hooks into Bukkit's plugin system and adds a handler to all plugin loggers to allow catching unreported exceptions. If already hooked, will do nothing. This method will continue to hook new plugins via a listener

Throws:

IllegalPluginAccessException - If something other than CodelanxLib calls this method

Since:

0.1.0

setReportingURL

public static void setReportingURL(String url)

Sets the URL to send a JSON payload of server information to as well as any other relevant information for when a stack trace occurs. This allows for a simple way of setting up error reporting. The default value for this is null, and as a result will not send any information upon errors occurring unless a target URL is set.

Parameters:

url - The URL to send JSON payloads to

Since:

0.1.0

toggleOutput

public static void toggleOutput(boolean output)

Sets whether or not to actually output any calls from your plugin to the Debugger. This defaults to false.

Parameters:

output - true if calls to the Debugger should print out

Since:

0.1.0

hideErrors

public static void hideErrors(boolean hide)

Sets whether or not calls to error(Throwable, String, Object...) will print errors. This is distinct from toggleOutput(boolean) and errors will not depend on its value. This defaults to false.

Parameters:

hide - true if errors should be printed

Since:

0.1.0

print

public static void print(Level level,
                         String format,
                         Object... args)

Prints to the Debugging Logger if toggleOutput(boolean) is set to true

Parameters:

level - The Level to print at

format - The formatting string

args - The printf arguments

Since:

0.1.0

print

public static void print(String format,
                         Object... args)

Prints to the Debugging Logger at Level.INFO if toggleOutput(boolean) is set to true

Parameters:

format - The formatting string

args - The printf arguments

Since:

0.1.0

error

public static void error(Throwable error,
                         String message,
                         Object... args)

Prints to the Debugging Logger at Level.SEVERE if toggleOutput(boolean) is set to true. It will also report the error with the URL set via setReportingURL(String). If that is null, nothing will be reported

Parameters:

error - The Throwable to be printed

message - The formatting string

args - The formatting arguments

Since:

0.1.0