StackWalker.Option (Java SE 9 & JDK 9 ) (original) (raw)

• java.lang.Object

• • java.lang.Enum<StackWalker.Option>
  • • java.lang.StackWalker.Option

• All Implemented Interfaces:
  [Serializable](../../java/io/Serializable.html "interface in java.io"), [Comparable](../../java/lang/Comparable.html "interface in java.lang")<[StackWalker.Option](../../java/lang/StackWalker.Option.html "enum in java.lang")>
  Enclosing class:
  StackWalker

public static enum StackWalker.Option
extends Enum<StackWalker.Option>
Stack walker option to configure the stack frame information obtained by a StackWalker.
Since:
9

• • Enum Constant Summary

  Enum Constants

  Enum Constant	Description
  RETAIN_CLASS_REFERENCE	Retains Class object in StackFrames walked by this StackWalker.
  SHOW_HIDDEN_FRAMES	Shows all hidden frames.
  SHOW_REFLECT_FRAMES	Shows all reflection frames.

  • Method Summary

  All Methods Static Methods Concrete Methods

  Modifier and Type	Method	Description
  static StackWalker.Option	valueOf​(String name)	Returns the enum constant of this type with the specified name.
  static StackWalker.Option[]	values​()	Returns an array containing the constants of this enum type, in the order they are declared.

     * ### Methods inherited from class java.lang.[Enum](../../java/lang/Enum.html "class in java.lang")  
     `[clone](../../java/lang/Enum.html#clone--), [compareTo](../../java/lang/Enum.html#compareTo-E-), [equals](../../java/lang/Enum.html#equals-java.lang.Object-), [finalize](../../java/lang/Enum.html#finalize--), [getDeclaringClass](../../java/lang/Enum.html#getDeclaringClass--), [hashCode](../../java/lang/Enum.html#hashCode--), [name](../../java/lang/Enum.html#name--), [ordinal](../../java/lang/Enum.html#ordinal--), [toString](../../java/lang/Enum.html#toString--), [valueOf](../../java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-)`  
     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[getClass](../../java/lang/Object.html#getClass--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Enum Constant Detail

     * #### RETAIN\_CLASS\_REFERENCE  
     public static final [StackWalker.Option](../../java/lang/StackWalker.Option.html "enum in java.lang") RETAIN_CLASS_REFERENCE  
     * #### SHOW\_REFLECT\_FRAMES  
     public static final [StackWalker.Option](../../java/lang/StackWalker.Option.html "enum in java.lang") SHOW_REFLECT_FRAMES  
     API Note:  
     This option includes the stack frames representing the invocation of`Method` and `Constructor`. Any utility methods that are equivalent to calling `Method.invoke` or`Constructor.newInstance` such as `Class.newInstance` are not filtered or controlled by any stack walking option.  
     * #### SHOW\_HIDDEN\_FRAMES  
     public static final [StackWalker.Option](../../java/lang/StackWalker.Option.html "enum in java.lang") SHOW_HIDDEN_FRAMES  
     Shows all hidden frames.  
     A Java Virtual Machine implementation may hide implementation specific frames in addition to [reflection frames](../../java/lang/StackWalker.Option.html#SHOW%5FREFLECT%5FFRAMES). A `StackWalker` with this `SHOW_HIDDEN_FRAMES` option will show all hidden frames (including reflection frames).  

  • Method Detail

    * #### values  
    public static [StackWalker.Option](../../java/lang/StackWalker.Option.html "enum in java.lang")[] values​()  
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:  
    for (StackWalker.Option c : StackWalker.Option.values())  
        System.out.println(c);  
    Returns:  
    an array containing the constants of this enum type, in the order they are declared  
    * #### valueOf  
    public static [StackWalker.Option](../../java/lang/StackWalker.Option.html "enum in java.lang") valueOf​([String](../../java/lang/String.html "class in java.lang") name)  
    Returns the enum constant of this type with the specified name. The string must match _exactly_ an identifier used to declare an enum constant in this type. (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](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if this enum type has no constant with the specified name  
    `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the argument is null

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.