Interface IVMRunner

All Known Implementing Classes:
AbstractVMRunner

public interface IVMRunner
A VM runner starts a Java VM running a Java program.

Clients may implement this interface to launch a new kind of VM.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    run(VMRunnerConfiguration configuration, org.eclipse.debug.core.ILaunch launch, org.eclipse.core.runtime.IProgressMonitor monitor)
    Launches a Java VM as specified in the given configuration, contributing results (debug targets and processes), to the given launch.
    default String
    showCommandLine(VMRunnerConfiguration configuration, org.eclipse.debug.core.ILaunch launch, org.eclipse.core.runtime.IProgressMonitor monitor)
    Gets the command line required to launch a Java VM as specified in the given configuration, contributing results (debug targets and processes), to the given launch.
  • Method Details

    • run

      void run(VMRunnerConfiguration configuration, org.eclipse.debug.core.ILaunch launch, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreException
      Launches a Java VM as specified in the given configuration, contributing results (debug targets and processes), to the given launch.
      Parameters:
      configuration - the configuration settings for this run
      launch - the launch to contribute to
      monitor - progress monitor or null A cancelable progress monitor is provided by the Job framework. It should be noted that the setCanceled(boolean) method should never be called on the provided monitor or the monitor passed to any delegates from this method; due to a limitation in the progress monitor framework using the setCanceled method can cause entire workspace batch jobs to be canceled, as the canceled flag is propagated up the top-level parent monitor. The provided monitor is not guaranteed to have been started.
      Throws:
      org.eclipse.core.runtime.CoreException - if an exception occurs while launching
    • showCommandLine

      default String showCommandLine(VMRunnerConfiguration configuration, org.eclipse.debug.core.ILaunch launch, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreException
      Gets the command line required to launch a Java VM as specified in the given configuration, contributing results (debug targets and processes), to the given launch.
      Parameters:
      configuration - the configuration settings for this run
      launch - the launch to contribute to
      monitor - progress monitor or null A cancelable progress monitor is provided by the Job framework. It should be noted that the setCanceled(boolean) method should never be called on the provided monitor or the monitor passed to any delegates from this method; due to a limitation in the progress monitor framework using the setCanceled method can cause entire workspace batch jobs to be canceled, as the canceled flag is propagated up the top-level parent monitor. The provided monitor is not guaranteed to have been started.
      Returns:
      the command line string
      Throws:
      org.eclipse.core.runtime.CoreException - if an exception occurs while getting the command line
      Since:
      3.11