org.rvpf.base.tool

Class Debug

Object

Debug

@Immutable
public final class Debug
extends Object

Debug. Provides convenience methods to help debugging.

Used for temporary logging; it is easy to clean up a project by getting a list of all references to this class.

Method Summary

Modifier and Type	Method and Description
static void	exit() Exits the current program with a failure status.
static void	log(String format, Object... params) Logs a message.
static void	log(Throwable throwable) Logs a throwable.
static void	log(Throwable throwable, String format, Object... params) Logs a message with a throwable.
static void	logStackTrace() Logs a stack trace of the current thread.
static void	logStackTrace(String format, Object... params) Logs a stack trace of the current thread with a message.
static void	logStackTrace(Throwable throwable) Logs the stack trace of the current thread with a throwable.
static void	logStackTrace(Throwable throwable, String format, Object... params) Logs a stack trace of the current thread with a message and a throwable.
static void	logStackTraces() Logs a stack trace of each thread.
static void	logStackTraces(String format, Object... params) Logs a stack trace of each thread with a message.
static void	logStackTraces(Throwable throwable) Logs the stack trace of each thread with a throwable.
static void	logStackTraces(Throwable throwable, String format, Object... params) Logs a stack trace of each thread with a message and a throwable.
static void	print(String format, Object... params) Prints a message.
static void	printStackTrace() Prints a stack trace of the current thread.
static void	printStackTrace(OutputStream outputStream) Prints a stack trace of the current thread.
static void	printStackTrace(PrintWriter printWriter) Prints a stack trace of the current thread.
static void	printStackTrace(String format, Object... params) Prints a stack trace of the current thread with a message.
static void	printStackTraces() Prints a stack trace of each thread.
static void	printStackTraces(OutputStream outputStream) Prints a stack traces of each thread.
static void	printStackTraces(PrintWriter printWriter) Prints a stack traces of each thread.
static void	printStackTraces(String format, Object... params) Prints a stack trace of each thread with a message.

Methods inherited from class Object

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

Method Detail

exit

public static void exit()

Exits the current program with a failure status.

log

public static void log(@Nonnull
                       Throwable throwable)

Logs a throwable.

Parameters:

throwable - The throwable.

log

public static void log(@Nonnull
                       String format,
                       @Nonnull
                       Object... params)

Logs a message.

Parameters:

format - The message format.

params - The message parameters.

log

public static void log(@Nonnull
                       Throwable throwable,
                       @Nonnull
                       String format,
                       @Nonnull
                       Object... params)

Logs a message with a throwable.

Parameters:

throwable - The throwable.

format - The message format.

params - The message parameters (optional).

logStackTrace

public static void logStackTrace()

Logs a stack trace of the current thread.

logStackTrace

public static void logStackTrace(@Nonnull
                                 Throwable throwable)

Logs the stack trace of the current thread with a throwable.

Parameters:

throwable - The throwable.

logStackTrace

public static void logStackTrace(@Nonnull
                                 String format,
                                 @Nonnull
                                 Object... params)

Logs a stack trace of the current thread with a message.

Parameters:

format - The message format.

params - The message parameters.

logStackTrace

public static void logStackTrace(@Nonnull
                                 Throwable throwable,
                                 @Nonnull
                                 String format,
                                 @Nonnull
                                 Object... params)

Logs a stack trace of the current thread with a message and a throwable.

Parameters:

throwable - The throwable.

format - The message format.

params - The message parameters.

logStackTraces

public static void logStackTraces()

Logs a stack trace of each thread.

logStackTraces

public static void logStackTraces(@Nonnull
                                  Throwable throwable)

Logs the stack trace of each thread with a throwable.

Parameters:

throwable - The throwable.

logStackTraces

public static void logStackTraces(@Nonnull
                                  String format,
                                  @Nonnull
                                  Object... params)

Logs a stack trace of each thread with a message.

Parameters:

format - The message format.

params - The message parameters.

logStackTraces

public static void logStackTraces(@Nonnull
                                  Throwable throwable,
                                  @Nonnull
                                  String format,
                                  @Nonnull
                                  Object... params)

Logs a stack trace of each thread with a message and a throwable.

Parameters:

throwable - The throwable.

format - The message format.

params - The message parameters.

print

public static void print(@Nonnull
                         String format,
                         @Nonnull
                         Object... params)

Prints a message.

Parameters:

format - The message format.

params - The message parameters.

printStackTrace

public static void printStackTrace()

Prints a stack trace of the current thread.

printStackTrace

public static void printStackTrace(@Nonnull
                                   OutputStream outputStream)

Prints a stack trace of the current thread.

Parameters:

outputStream - The destination output stream.

printStackTrace

public static void printStackTrace(@Nonnull
                                   PrintWriter printWriter)

Prints a stack trace of the current thread.

Parameters:

printWriter - The destination print writer.

printStackTrace

public static void printStackTrace(@Nonnull
                                   String format,
                                   @Nonnull
                                   Object... params)

Prints a stack trace of the current thread with a message.

Parameters:

format - The message format.

params - The message parameters.

printStackTraces

public static void printStackTraces()

Prints a stack trace of each thread.

printStackTraces

public static void printStackTraces(@Nonnull
                                    OutputStream outputStream)

Prints a stack traces of each thread.

Parameters:

outputStream - The destination output stream.

printStackTraces

public static void printStackTraces(@Nonnull
                                    PrintWriter printWriter)

Prints a stack traces of each thread.

Parameters:

printWriter - The destination print writer.

printStackTraces

public static void printStackTraces(@Nonnull
                                    String format,
                                    @Nonnull
                                    Object... params)

Prints a stack trace of each thread with a message.

Parameters:

format - The message format.

params - The message parameters.