Package io.helidon.common

Class StackWalker

java.lang.Object

io.helidon.common.StackWalker

public final class StackWalker
extends Object

A dummy replicate of Java9's StackWalker.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StackWalker.Option Option for future partial compatibility with Java9.

Method Summary

Modifier and Type	Method and Description
Class<?>	getCallerClass() Gets the Class object of the caller who invoked the method that invoked getCallerClass.
static StackWalker	getInstance() Returns a StackWalker instance with default options.
static StackWalker	getInstance(Set<StackWalker.Option> options) Returns a StackWalker instance with the given options specifying the stack frame information it can access.
static StackWalker	getInstance(StackWalker.Option option) Returns a StackWalker instance with the given option specifying the stack frame information it can access.
Optional<StackTraceElement>	walk(Function<? super Stream<StackTraceElement>,Optional<StackTraceElement>> function) Applies the given function to the stream of StackFrames for the current thread, traversing from the top frame of the stack, which is the method calling this walk method.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static StackWalker getInstance()

Returns a StackWalker instance with default options.

Returns:

a StackWalker configured with the default options

getInstance

public static StackWalker getInstance(StackWalker.Option option)

Returns a StackWalker instance with the given option specifying the stack frame information it can access.

Parameters:

option - ignored (used by java9 forward)

Returns:

a StackWalker configured with the given options

getInstance

public static StackWalker getInstance(Set<StackWalker.Option> options)

Returns a StackWalker instance with the given options specifying the stack frame information it can access.

Parameters:

options - ignored (used by java9 forward)

Returns:

a StackWalker configured with the given options

getCallerClass

public Class<?> getCallerClass()

Gets the Class object of the caller who invoked the method that invoked getCallerClass.

Returns:

Class object of the caller's caller invoking this method.

walk

public Optional<StackTraceElement> walk(Function<? super Stream<StackTraceElement>,Optional<StackTraceElement>> function)

Applies the given function to the stream of StackFrames for the current thread, traversing from the top frame of the stack, which is the method calling this walk method.

Parameters:

function - a function that takes a stream of stack frames and returns a result.

Returns:

the result of applying the function to the stream of stack frame.