com.protomatter.util
Class StackTraceInfo

java.lang.Object
  |
  +--com.protomatter.util.StackTraceInfo

public class StackTraceInfo

extends java.lang.Object

A utility class describing a position in a method call stack.

Field Summary

java.lang.String	className The full class name.
static int	LINE_NUMBER_UNKNOWN Calling method line number is unknown.
int	lineNumber The line number, if known.
java.lang.String	methodName The method name.

Constructor Summary

StackTraceInfo()
Default constructor.

StackTraceInfo(java.lang.String className, java.lang.String methodName)
Utility constructor.

StackTraceInfo(java.lang.String className, java.lang.String methodName, int line)
Utility constructor.

Method Summary

java.lang.String	getClassAndMethod()
java.lang.String	getShortClassAndMethod()
java.lang.String	toString() Generate a nice display of the stack location.

Methods inherited from class java.lang.Object

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

Field Detail

LINE_NUMBER_UNKNOWN

public static int LINE_NUMBER_UNKNOWN

Calling method line number is unknown.

className

public java.lang.String className

The full class name.

methodName

public java.lang.String methodName

The method name.

lineNumber

public int lineNumber

The line number, if known.

Constructor Detail

StackTraceInfo

public StackTraceInfo()

Default constructor.

StackTraceInfo

public StackTraceInfo(java.lang.String className,
                      java.lang.String methodName)

Utility constructor.

StackTraceInfo

public StackTraceInfo(java.lang.String className,
                      java.lang.String methodName,
                      int line)

Utility constructor.

Method Detail

toString

public java.lang.String toString()

Generate a nice display of the stack location. Output looks like this: "full.class.Name.methodName():line" if the line number is known, and like "full.class.Name.methodName()" if the line number isn't known.

This is suitable for doing things like "Syslog.debug(this, "I'm right here: " + StackTraceUtil.whereAmI());" for good debugging statements. This is also the format used for when the Syslog.crumb() and Channel.crumb() tracing methods work.

Overrides:

toString in class java.lang.Object

getClassAndMethod

public java.lang.String getClassAndMethod()

getShortClassAndMethod

public java.lang.String getShortClassAndMethod()