com.github.writethemfirst.approvals.utils

Class StackUtils

java.lang.Object

com.github.writethemfirst.approvals.utils.StackUtils

public class StackUtils
extends java.lang.Object

StackUtils

Set of static methods to be used when parsing of the current Thread stacktrace, allowing to retrieve helpful information about the classes and methods actually calling the Approval Tests.

Those methods allow to retrieve information to be used for generating the default names of files and folders to be used by the Approval Files.

Constructor Summary

Constructors

Constructor and Description
StackUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.Class<?>	callerClass(java.lang.Class<?>... referenceClass) Returns the caller class of reference by searching the current thread stacktrace.
static java.util.Optional<java.lang.String>	callerMethod(java.lang.Class<?> referenceClass) Returns the caller method of the provided referenceClass.

Methods inherited from class java.lang.Object

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

Constructor Detail

StackUtils

public StackUtils()

Method Detail

callerClass

public static java.lang.Class<?> callerClass(java.lang.Class<?>... referenceClass)

Returns the caller class of reference by searching the current thread stacktrace.

We consider the caller class to be the first one found in the current thread stacktrace after finding the reference one.

Parameters:

referenceClass - A non-null class for which we want to find the caller class

Returns:

The caller class of the provided one (ie. the first one found which isn’t the reference after finding the reference)

callerMethod

public static java.util.Optional<java.lang.String> callerMethod(java.lang.Class<?> referenceClass)

Returns the caller method of the provided referenceClass.

We consider the caller method to be the first method from the referenceClass called in the current thread stacktrace, which isn’t a lambda.

If found in the current thread stacktrace, the method name will be returned, wrapped in an Optional. If no method can be found, an empty Optional will be returned.

Parameters:

referenceClass - The referenceClass for which we want to search the caller method in the current thread stacktrace

Returns:

An Optional object containing either the caller method name (as a String) or an empty value if it cannot be found