loci.common

Class DebugTools

java.lang.Object

loci.common.DebugTools

public final class DebugTools
extends Object

A utility class with convenience methods for debugging.

Author:

Curtis Rueden ctrueden at wisc.edu

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DebugTools()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	enableIJLogging(boolean debug) Enable SLF4J logging using logback, in the context of ImageJ.
static boolean	enableLogging(String level) Attempts to enable SLF4J logging via logback or log4j without an external configuration file.
static String	getFieldName(Class<?> c, int value) This method uses reflection to scan the values of the given class's static fields, returning the first matching field's name.
static String	getStackTrace(Throwable t) Extracts the given exception's corresponding stack trace to a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

DebugTools

private DebugTools()

Method Detail

getStackTrace

public static String getStackTrace(Throwable t)

Extracts the given exception's corresponding stack trace to a string.

enableLogging

public static boolean enableLogging(String level)

Attempts to enable SLF4J logging via logback or log4j without an external configuration file.

Parameters:

level - A string indicating the desired level (i.e.: ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE, WARN).

Returns:

true iff logging was successfully enabled

enableIJLogging

public static boolean enableIJLogging(boolean debug)

Enable SLF4J logging using logback, in the context of ImageJ. This allows logging events to be echoed to the ImageJ status bar, regardless of how the logging configuration file was set up.

Parameters:

debug - true if debug-level output should be shown

Returns:

whether or not ImageJ log enabling was successful

getFieldName

public static String getFieldName(Class<?> c,
                  int value)

This method uses reflection to scan the values of the given class's static fields, returning the first matching field's name.