de.cismet.commons.utils

Class StackUtils

java.lang.Object

de.cismet.commons.utils.StackUtils

public final class StackUtils
extends Object

Useful operations concerning stacktraces, mainly for debugging purposes.

Version:

1.0

Author:

martin.scholl@cismet.de

Method Summary

Modifier and Type	Method and Description
static boolean	equals(StackTraceElement[] ste1, StackTraceElement[] ste2, boolean lineNumbers) Tests the equality of two stacktraces.
static boolean	equals(StackTraceElement ste1, StackTraceElement ste2, boolean lineNumbers) Tests the equality of two StackTraceElements.
static Throwable	getDebuggingThrowable() Creates a Throwable whose first (topmost) element is the line of the calling method.
static String	getMethodName() Gets the name of the method that calls this method.
static String	getMethodName(boolean canonicalName, boolean printValues, Object... paramInstances) Gets the name of the method that calls this method.
static String	getMethodName(boolean canonicalName, Object... paramInstances) Gets the name of the method that calls this method.
static String	getMethodName(Object... paramInstances) Gets the name of the method that calls this method.

Methods inherited from class java.lang.Object

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

Method Detail

getMethodName

public static String getMethodName()

Gets the name of the method that calls this method. Equal to calling getMethodName(boolean, boolean, java.lang.Object[]) with false as value for the canonicalName and pringValues parameter and null as value for the paramInstances parameter.

Returns:

the name of the method that calls this method

See Also:

getMethodName(boolean, boolean, java.lang.Object[])

getMethodName

public static String getMethodName(Object... paramInstances)

Gets the name of the method that calls this method. Equal to calling getMethodName(boolean, boolean, java.lang.Object[]) with false as value for the canonicalName and pringValues parameter.

Parameters:

paramInstances - the parameters that shall be printed with this method name

Returns:

the name of the method that calls this method

See Also:

getMethodName(boolean, boolean, java.lang.Object[])

getMethodName

public static String getMethodName(boolean canonicalName,
                                   Object... paramInstances)

Gets the name of the method that calls this method. Equal to calling getMethodName(boolean, boolean, java.lang.Object[]) with false as value for the pringValues parameter.

Parameters:

canonicalName - whether the class names of the paramInstances shall be canonical or simple

paramInstances - the parameters that shall be printed with this method name

Returns:

the name of the method that calls this method

See Also:

getMethodName(boolean, boolean, java.lang.Object[])

getMethodName

public static String getMethodName(boolean canonicalName,
                                   boolean printValues,
                                   Object... paramInstances)

Gets the name of the method that calls this method. If optionally provided with a list of parameters it prints their type (Class), too, depending on the canonicalName flag, e.g.

myShinyMethod(String,boolean) if canonicalName is false.

If the printValues is true it additionally appends the results of the toString() operations of the single methods like so:

myShinyMethod(String{myString}).

NOTE:This should mainly be used for debugging purposes as it is a rather slow implementation.

Parameters:

canonicalName - whether the class names of the paramInstances shall be canonical or simple

printValues - whether the actual values of the paramInstances shall be printed

paramInstances - the parameters that shall be printed with this method name

Returns:

the name of the method that calls this method

getDebuggingThrowable

public static Throwable getDebuggingThrowable()

Creates a Throwable whose first (topmost) element is the line of the calling method. As the name suggests this operation should only be used for debugging purposes.

Returns:

a Throwable whose first (topmost) element is the line of the calling method

equals

public static boolean equals(StackTraceElement[] ste1,
                             StackTraceElement[] ste2,
                             boolean lineNumbers)

Tests the equality of two stacktraces. Internally makes use of equals(java.lang.StackTraceElement, java.lang.StackTraceElement, boolean)

Parameters:

ste1 - first stacktrace

ste2 - second stacktrace

lineNumbers - if line numbers shall be included in the equality check

Returns:

true if the stacktraces are equal, false otherwise

Throws:

IllegalArgumentException - if at least one argument is null

equals

public static boolean equals(StackTraceElement ste1,
                             StackTraceElement ste2,
                             boolean lineNumbers)

Tests the equality of two StackTraceElements. Two elements are considered equal if their method, classname and filename are equal. Optionally the equality check is done also for their line numbers.

Parameters:

ste1 - first StackTraceElement

ste2 - seconed StackTraceElement

lineNumbers - if true line numbers are included in the equality check

Returns:

true if the StackTraceElements are equal, false otherwise

Throws:

IllegalArgumentException - if any of the arguments is null