Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

javax.ide.debug
Class Connector  view Connector download Connector.java

java.lang.Object
  extended byjavax.ide.debug.Connector
Direct Known Subclasses:
ClientConnector, ServerConnector

public abstract class Connector
extends java.lang.Object

The Connector interface is used to connect to a debugging session. The Connector object is used to start the debuggee or to retrieve command line options so the extension can start the debuggee itself.

IDE providers must provide an implementation of this interface. Extension writers can access the Connector through the Debugger.getClientConnector(javax.ide.command.Context) 55 and Debugger.getServerConnector(javax.ide.command.Context) 55 methods.


Field Summary
static java.lang.String OPTION_CLASSPATH
           
static java.lang.String OPTION_DEBUG_FIRST
           
static java.lang.String OPTION_DEBUG_LAST
           
static java.lang.String OPTION_JAVA_EXECUTABLE
           
static java.lang.String OPTION_JAVA_OPTIONS
           
static java.lang.String OPTION_JVM
           
static java.lang.String OPTION_MAIN_CLASS
           
static java.lang.String OPTION_PROGRAM_ARGUMENTS
           
 
Constructor Summary
Connector()
           
 
Method Summary
abstract  javax.ide.command.Context getContext()
          Get the javax.ide.command.Context used to create this connector.
abstract  java.util.Map getOptions()
          Get the options the extension should use when starting the debuggee.
abstract  boolean isConnected()
          Check if the debugger has connected to the debuggee.
abstract  boolean isFinished()
          Check if the debugger has finished debugging.
abstract  java.lang.Process startDebuggee(java.util.Map options)
          Start the debuggee process.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OPTION_JAVA_EXECUTABLE

public static final java.lang.String OPTION_JAVA_EXECUTABLE
See Also:
Constant Field Values

OPTION_JVM

public static final java.lang.String OPTION_JVM
See Also:
Constant Field Values

OPTION_DEBUG_FIRST

public static final java.lang.String OPTION_DEBUG_FIRST
See Also:
Constant Field Values

OPTION_CLASSPATH

public static final java.lang.String OPTION_CLASSPATH
See Also:
Constant Field Values

OPTION_JAVA_OPTIONS

public static final java.lang.String OPTION_JAVA_OPTIONS
See Also:
Constant Field Values

OPTION_DEBUG_LAST

public static final java.lang.String OPTION_DEBUG_LAST
See Also:
Constant Field Values

OPTION_MAIN_CLASS

public static final java.lang.String OPTION_MAIN_CLASS
See Also:
Constant Field Values

OPTION_PROGRAM_ARGUMENTS

public static final java.lang.String OPTION_PROGRAM_ARGUMENTS
See Also:
Constant Field Values
Constructor Detail

Connector

public Connector()
Method Detail

getOptions

public abstract java.util.Map getOptions()
Get the options the extension should use when starting the debuggee. The extension will mostly call this method when it wants to start the debuggee process itself. If the extension wants the IDE to start the debuggee process, this method does not need to be called, unless the extension wants to modify some of the command line options. Returns a Map where the keys are the following String constants OPTION_JAVA_EXECUTABLE 55 , OPTION_JVM 55 , OPTION_DEBUG_FIRST 55 , OPTION_CLASSPATH 55 , OPTION_JAVA_OPTIONS 55 , OPTION_DEBUG_LAST 55 , OPTION_MAIN_CLASS 55 , OPTION_PROGRAM_ARGUMENTS 55 , and the values are String[]. Each String[] value can be null, if no options are necessary, or an array of one or more Strings.


startDebuggee

public abstract java.lang.Process startDebuggee(java.util.Map options)
                                         throws java.io.IOException
Start the debuggee process. The extension should call this method when it wants the IDE to start the debuggee process. The options can be a full set of command line options as returned getOptions() 55 , or it can be a partial set of options. If the options map contains a key/value pair, the value specified will override the value that the IDE would ordinarily use for that key. If the extension does not want to override any options, the options parameter can be null. For example, if a extension wants to add an additional program argument, it should call getOptions() 55 and get the value for OPTION_PROGRAM_ARGUMENTS 55 out of the Map. It should then create a new String[] to hold the original program arguments plus the additional program argument. It should then put this new String[] into the Map before passing it to startDebuggee.


isConnected

public abstract boolean isConnected()
Check if the debugger has connected to the debuggee.


isFinished

public abstract boolean isFinished()
Check if the debugger has finished debugging.


getContext

public abstract javax.ide.command.Context getContext()
Get the javax.ide.command.Context used to create this connector.