jhelp.util.debug

Class Debug

java.lang.Object

jhelp.util.debug.Debug

public final class Debug
extends java.lang.Object

Class for debugging and thread safe.
We avoid dummy printings

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private static DebugLevel	debugLevel Actual debug level
private static java.util.concurrent.locks.ReentrantLock	REENTRANT_LOCK For synchronize the printing (To be thread safe)

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Debug() To avoid instance

Method Summary

Methods

Modifier and Type	Method and Description
static DebugLevel	getDebugLevel() Actual debug level
static void	printCalledFrom(DebugLevel debugLevel) Print information to know which part of code, called a method.
static void	printError(java.lang.Error error, java.lang.Object... message) Print an error with its trace
static void	printException(java.lang.Exception exception, java.lang.Object... message) Print an exception with its trace
private static void	printInteger(int integer, int characterNumber) Print an integer
static void	println(DebugLevel debugLevel, java.lang.Object... message) Print some information
static void	printMark(DebugLevel debugLevel, java.lang.String mark) Print a mark
private static void	printMessage(DebugLevel debugLevel, java.lang.StackTraceElement stackTraceElement, java.lang.Object... message) Print a message
private static void	printObject(java.lang.Object object) Print an object
static void	printTodo(java.lang.Object... message) Print a to do message
static void	printTrace(DebugLevel debugLevel, java.lang.Object... message) Print an informative trace (To know the execution stack)
private static void	printTrace(DebugLevel debugLevel, java.lang.Throwable throwable, int start) Print a trace
static void	setDebugLevel(DebugLevel debugLevel) Change debug level

Methods inherited from class java.lang.Object

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

Field Detail

debugLevel

private static DebugLevel debugLevel

Actual debug level

REENTRANT_LOCK

private static final java.util.concurrent.locks.ReentrantLock REENTRANT_LOCK

For synchronize the printing (To be thread safe)

Constructor Detail

Debug

private Debug()

To avoid instance

Method Detail

printInteger

private static void printInteger(int integer,
                int characterNumber)

Print an integer

Parameters:

integer - Integer to print

characterNumber - Number of character must show

printMessage

private static void printMessage(DebugLevel debugLevel,
                java.lang.StackTraceElement stackTraceElement,
                java.lang.Object... message)

Print a message

Parameters:

debugLevel - Debug level

stackTraceElement - Trace of the source

message - Message to print

printObject

private static void printObject(java.lang.Object object)

Print an object

Parameters:

object - Object to print

printTrace

private static void printTrace(DebugLevel debugLevel,
              java.lang.Throwable throwable,
              int start)

Print a trace

Parameters:

debugLevel - Debug level

throwable - Trace to print

start - Offset to start reading the trace

getDebugLevel

public static DebugLevel getDebugLevel()

Actual debug level

Returns:

Actual debug level

printCalledFrom

public static void printCalledFrom(DebugLevel debugLevel)

Print information to know which part of code, called a method.
Short version of printTrace(DebugLevel, Object...)

Parameters:

debugLevel - Debug level

printError

public static void printError(java.lang.Error error,
              java.lang.Object... message)

Print an error with its trace

Parameters:

error - Error to print

message - Message information

printException

public static void printException(java.lang.Exception exception,
                  java.lang.Object... message)

Print an exception with its trace

Parameters:

exception - Exception to print

message - Message information

println

public static void println(DebugLevel debugLevel,
           java.lang.Object... message)

Print some information

Parameters:

debugLevel - Debug level

message - Message to print

printMark

public static void printMark(DebugLevel debugLevel,
             java.lang.String mark)

Print a mark

Parameters:

debugLevel - Debug level

mark - Mark to print

printTodo

public static void printTodo(java.lang.Object... message)

Print a to do message

Parameters:

message - Message to print

printTrace

public static void printTrace(DebugLevel debugLevel,
              java.lang.Object... message)

Print an informative trace (To know the execution stack)

Parameters:

debugLevel - Debug level

message - Message to print

setDebugLevel

public static void setDebugLevel(DebugLevel debugLevel)

Change debug level

Parameters:

debugLevel - New debug level