org.yarnandtail.andhow.util

Class StackLocator

java.lang.Object

org.yarnandtail.andhow.util.StackLocator

public class StackLocator
extends Object

A utility class for find the calling class, method and line number for use in creating more detailed logging information. This class was mostly copied from the class of the same name in the Apache log4j project.

Method Summary

Modifier and Type	Method and Description
StackTraceElement	calcLocation(String fqcnOfLogger)
Class<?>	getCallerClass(Class<?> anchor) Reverse engr docs: I think this returns the class of the caller to the first found instance of the anchor class in the current stack.
Class<?>	getCallerClass(int depth)
Class<?>	getCallerClass(String fqcn, String pkg) Reverse engr some docs here: I think this returns the calling class from a specified package.
Stack<Class<?>>	getCurrentStackTrace()
static StackLocator	getInstance()
protected org.yarnandtail.andhow.util.StackLocator.PrivateSecurityManager	getSecurityManager()
StackTraceElement	getStackTraceElement(int depth)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static StackLocator getInstance()

getCallerClass

public Class<?> getCallerClass(int depth)

getCallerClass

public Class<?> getCallerClass(String fqcn,
                               String pkg)

Reverse engr some docs here: I think this returns the calling class from a specified package.

Parameters:

fqcn - Fully qualified class name of the class that was called.

pkg - Package of the class you are interested in finding who called the fqcn class.

Returns:

The Class that made the call, or null if it cannot be found.

getCallerClass

public Class<?> getCallerClass(Class<?> anchor)

Reverse engr docs: I think this returns the class of the caller to the first found instance of the anchor class in the current stack. This could return the anchor class if the caller was in the same class.

Parameters:

anchor -

Returns:

getCurrentStackTrace

public Stack<Class<?>> getCurrentStackTrace()

calcLocation

public StackTraceElement calcLocation(String fqcnOfLogger)

getStackTraceElement

public StackTraceElement getStackTraceElement(int depth)

getSecurityManager

protected org.yarnandtail.andhow.util.StackLocator.PrivateSecurityManager getSecurityManager()