Enum Class StackWalker.Option

java.lang.Object
java.lang.Enum<StackWalker.Option>
java.lang.StackWalker.Option
All Implemented Interfaces:
Serializable,Comparable<StackWalker.Option>,Constable
Enclosing class:
StackWalker
public static enumStackWalker.OptionextendsEnum<StackWalker.Option>
Stack walker option to configure thestack frame information obtained by aStackWalker.
Since:
9

  • Enum Constant Details

    • RETAIN_CLASS_REFERENCE

      public static final StackWalker.Option RETAIN_CLASS_REFERENCE
      RetainsClass object inStackFrames walked by thisStackWalker.

      AStackWalker configured with this option will supportStackWalker.getCallerClass() andStackFrame.getDeclaringClass().

    • DROP_METHOD_INFO

      public static final StackWalker.Option DROP_METHOD_INFO
      Drops the method information fromStackFrames walked by thisStackWalker.

      AStackWalker configured with this option will drop themethod name, themethod type, theline number, thebytecode index, thesource file name andnative method or not.

      Since:
      22

    • SHOW_REFLECT_FRAMES

      public static final StackWalker.Option SHOW_REFLECT_FRAMES
      Shows all reflection frames.

      By default, reflection frames are hidden. AStackWalker configured with thisSHOW_REFLECT_FRAMES option will show all reflection frames that includeMethod.invoke(java.lang.Object, java.lang.Object...) andConstructor.newInstance(Object...) and their reflection implementation classes.

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

      API Note:
      This option includes the stack frames representing the invocation ofMethod andConstructor. Any utility methods that are equivalent to callingMethod.invoke orConstructor.newInstance such asClass.newInstance are not filtered or controlled by any stack walking option.

    • SHOW_HIDDEN_FRAMES

      public static final StackWalker.Option SHOW_HIDDEN_FRAMES
      Shows all hidden frames.

      A Java Virtual Machine implementation may hide implementation specific frames in addition toreflection frames. AStackWalker with thisSHOW_HIDDEN_FRAMES option will show all hidden frames (including reflection frames).

  • Method Details

    • values

      public static StackWalker.Option[] values()
      Returns an array containing the constants of this enum class, inthe order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static StackWalker.Option valueOf(String name)
      Returns the enum constant of this class with the specified name.The string must matchexactly an identifier used to declare anenum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null