Interface ScriptDebugging.DebuggerInstaller

  • Enclosing class:
    ScriptDebugging

    public static interface ScriptDebugging.DebuggerInstaller
    Implemented by classes that can install a script debugger. This is similar to a factory, but only one debugger can be installed at a time. This interface allows a debugger to be installed or uninstalled, and provides very high-level access to the debugger once installed.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void install()
      Called to start the debugging service.
      boolean isClientRunning()
      Returns true if the debugging client is currently running.
      void prepareToEnterContext()
      Called before entering a thread context.
      void preprocessScript​(java.lang.String location, java.lang.String scriptSource)
      Called to allow the debugger to process a script that has not been compiled or run yet, but that the user of the debugger might wish to have available (for example, to set breakpoints before the script is actually run).
      void setBreak()
      Set a breakpoint at the earliest opportunity.
      void startClient()
      Start or display the debug client window.
      void uninstall()
      Called to stop the debugging service.
    • Method Detail

      • install

        void install()
        Called to start the debugging service.
      • uninstall

        void uninstall()
        Called to stop the debugging service.
      • preprocessScript

        void preprocessScript​(java.lang.String location,
                              java.lang.String scriptSource)
        Called to allow the debugger to process a script that has not been compiled or run yet, but that the user of the debugger might wish to have available (for example, to set breakpoints before the script is actually run).
        Parameters:
        location - the file or other identifier for the script
        scriptSource - the source code for the script
      • prepareToEnterContext

        void prepareToEnterContext()
        Called before entering a thread context.
      • setBreak

        void setBreak()
        Set a breakpoint at the earliest opportunity. The effect of calling this when the matching debugger is not installed is undefined.
      • startClient

        void startClient()
                  throws java.io.IOException
        Start or display the debug client window.
        Throws:
        java.io.IOException
      • isClientRunning

        boolean isClientRunning()
        Returns true if the debugging client is currently running.
        Returns:
        true if the client is active