org.dmd.util.exceptions

Class DebugInfo

java.lang.Object

org.dmd.util.exceptions.DebugInfo

public class DebugInfo
extends Object

This class allows you to generate a stack trace for inclusion in error messages.

Constructor Summary

Constructors

Constructor and Description
DebugInfo()

Method Summary

Modifier and Type	Method and Description
static void	debug(String s) A cheap way to dump a temporary debug statement to System.out that indicates where it's being dumped from.
static void	debugWithTrace(String s)
static String	extractTheStack(Exception ex) A convenience function to extract the stack from an exception as a string.
static String	getCompleteCurrentMethod() Gets the name of the current method.
static void	getCurrentLine() Gets the current line number.
static String	getCurrentLineNumber()
static String	getCurrentMethod() Gets the name of the current method.
static String	getCurrentStack() Gets a stack trace to the current point in the code.
static String	getEnumerationString(Class obj, int value)
static String	getShortWhereWeWereCalledFrom() Returns where the current function was called from.
static String	getWhereWeAreNow() Returns where we are calling this function from.
static String	getWhereWeAreNowShort() Returns just the class and line number from where we were called.
static String	getWhereWeWereCalledFrom() Returns where the current function was called from.

Methods inherited from class java.lang.Object

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

Constructor Detail

DebugInfo

public DebugInfo()

Method Detail

getCurrentStack

public static String getCurrentStack()

Gets a stack trace to the current point in the code.

getWhereWeWereCalledFrom

public static String getWhereWeWereCalledFrom()

Returns where the current function was called from. At this level, the stack trace looks like: at com.dmc.util.DebugInfo.getWhereWeWereCalledFrom(DebugInfo.java:35) at com.dmc.dmd.meta.CreateMeta.dumpMetaSchema(CreateMeta.java:510) at com.dmc.dmd.meta.CreateMeta.run(CreateMeta.java:189) at com.dmc.dmd.meta.CreateMetaMain.main(MetaGeneratorMain.java:8) We want the contents of the third line in the stack.

Returns:

Where we're calling this function from.

getShortWhereWeWereCalledFrom

public static String getShortWhereWeWereCalledFrom()

Returns where the current function was called from. At this level, the stack trace looks like: at com.dmc.util.DebugInfo.getWhereWeWereCalledFrom(DebugInfo.java:35) at com.dmc.dmd.meta.CreateMeta.dumpMetaSchema(CreateMeta.java:510) at com.dmc.dmd.meta.CreateMeta.run(CreateMeta.java:189) at com.dmc.dmd.meta.CreateMetaMain.main(MetaGeneratorMain.java:8) We want the contents of the third line in the stack.

Returns:

Where we're calling this function from.

getWhereWeAreNow

public static String getWhereWeAreNow()

Returns where we are calling this function from. This is useful if you want to document generated code and see where the code was created from. At this level, the stack trace looks like: at com.dmc.util.DebugInfo.getWhereWeWereCalledFrom(DebugInfo.java:35) at com.dmc.dmd.meta.CreateMeta.dumpMetaSchema(CreateMeta.java:510) at com.dmc.dmd.meta.CreateMeta.run(CreateMeta.java:189) at com.dmc.dmd.meta.CreateMetaMain.main(MetaGeneratorMain.java:8) We want the contents of the second line in the stack.

Returns:

Where we're calling this function from.

getWhereWeAreNowShort

public static String getWhereWeAreNowShort()

Returns just the class and line number from where we were called. At this level, the stack trace looks like: at com.dmc.util.DebugInfo.getWhereWeWereCalledFrom(DebugInfo.java:35) at com.dmc.dmd.meta.CreateMeta.dumpMetaSchema(CreateMeta.java:510) at com.dmc.dmd.meta.CreateMeta.run(CreateMeta.java:189) at com.dmc.dmd.meta.CreateMetaMain.main(MetaGeneratorMain.java:8) We want the contents of the second line in the stack between the last brackets.

Returns:

Where we're calling this function from.

getCurrentMethod

public static String getCurrentMethod()

Gets the name of the current method.

getCompleteCurrentMethod

public static String getCompleteCurrentMethod()

Gets the name of the current method.

getCurrentLine

public static void getCurrentLine()

Gets the current line number.

getCurrentLineNumber

public static String getCurrentLineNumber()

Returns:

The line number in the file from which this method is called.

getEnumerationString

public static String getEnumerationString(Class obj,
                                          int value)

debugWithTrace

public static void debugWithTrace(String s)

debug

public static void debug(String s)

A cheap way to dump a temporary debug statement to System.out that indicates where it's being dumped from.

extractTheStack

public static String extractTheStack(Exception ex)

A convenience function to extract the stack from an exception as a string.