Package ghidra.app.script

Enum GhidraScript.AnalysisMode

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DISABLED
      DISABLED - Script will coordinate with AutoAnalysisManager to run with analysis disabled (change events will be ignored).
      ENABLED
      ENABLED - Script will run normally with Auto-Analysis responding to changes
      SUSPENDED
      SUSPENDED - Script will coordinate with AutoAnalysisManager to run with analysis suspended (change events will be analyzed after script execution completes).

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static GhidraScript.AnalysisMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static GhidraScript.AnalysisMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • ENABLED

        public static final GhidraScript.AnalysisMode ENABLED
        ENABLED - Script will run normally with Auto-Analysis responding to changes

      • DISABLED

        public static final GhidraScript.AnalysisMode DISABLED
        DISABLED - Script will coordinate with AutoAnalysisManager to run with analysis disabled (change events will be ignored). Script will wait for any pending analysis to complete. Within headed environments an additional modal task dialog will be displayed while the script is active to prevent the user from initiating additional program changes.

      • SUSPENDED

        public static final GhidraScript.AnalysisMode SUSPENDED
        SUSPENDED - Script will coordinate with AutoAnalysisManager to run with analysis suspended (change events will be analyzed after script execution completes). Script will wait for any pending analysis to complete.

    • Method Detail

      • values

        public static GhidraScript.AnalysisMode[] 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 (GhidraScript.AnalysisMode c : GhidraScript.AnalysisMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static GhidraScript.AnalysisMode valueOf​(java.lang.String 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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null