StackWalker.Option | API reference

Summary: Enums | Methods | Inherited Methods

public static final enum StackWalker.Option
extends Enum<StackWalker.Option>

Stack walker option to configure the stack frame information obtained by a StackWalker.

Summary

Enum values
`StackWalker.Option`	`RETAIN_CLASS_REFERENCE` Retains `Class` object in `StackFrame`s walked by this `StackWalker`.
`StackWalker.Option`	`SHOW_HIDDEN_FRAMES` Shows all hidden frames.
`StackWalker.Option`	`SHOW_REFLECT_FRAMES` Shows all reflection frames.

Public methods
`static StackWalker.Option`	`valueOf(String name)`
`static final Option[]`	`values()`

Inherited methods

From class java.lang.Enum

`final Object`	`clone()` Throws CloneNotSupportedException.
`final int`	`compareTo(StackWalker.Option o)` Compares this enum with the specified object for order.
`final boolean`	`equals(Object other)` Returns true if the specified object is equal to this enum constant.
`final void`	`finalize()` enum classes cannot have finalize methods.
`final Class<StackWalker.Option>`	`getDeclaringClass()` Returns the Class object corresponding to this enum constant's enum type.
`final int`	`hashCode()` Returns a hash code for this enum constant.
`final String`	`name()` Returns the name of this enum constant, exactly as declared in its enum declaration.
`final int`	`ordinal()` Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
`String`	`toString()` Returns the name of this enum constant, as contained in the declaration.
`static <T extends Enum<T>> T`	`valueOf(Class<T> enumClass, String name)` Returns the enum constant of the specified enum class with the specified name.

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface java.lang.Comparable


      compareTo(StackWalker.Option o)

Compares this object with the specified object for order.

Enum values

RETAIN_CLASS_REFERENCE

Added in API level 34

public static final StackWalker.Option RETAIN_CLASS_REFERENCE

Retains Class object in StackFrames walked by this StackWalker.

A StackWalker configured with this option will support StackWalker.getCallerClass() and StackFrame.getDeclaringClass().

SHOW_HIDDEN_FRAMES

Added in API level 34

public static final StackWalker.Option SHOW_HIDDEN_FRAMES

Shows all hidden frames.

A Java Virtual Machine implementation may hide implementation specific frames in addition to reflection frames. A StackWalker with this SHOW_HIDDEN_FRAMES option will show all hidden frames (including reflection frames).

SHOW_REFLECT_FRAMES

Added in API level 34

public static final StackWalker.Option SHOW_REFLECT_FRAMES

Shows all reflection frames.

By default, reflection frames are hidden. A StackWalker configured with this SHOW_REFLECT_FRAMES option will show all reflection frames that include Method.invoke(Object, Object) and java.lang.reflect.Constructor.newInstance(Object...) and their reflection implementation classes.

The SHOW_HIDDEN_FRAMES option can also be used to show all reflection frames and it will also show other hidden frames that are implementation-specific.

Public methods

valueOf

public static StackWalker.Option valueOf (String name)

Parameters
`name`	`String`

Returns
`StackWalker.Option`

values

public static final Option[] values ()

Returns
`Option[]`

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.