eclipseme.core.model
Interface IJavaBasedEmulator

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IEmulator, IPlatformComponent

public interface IJavaBasedEmulator
extends IEmulator

Instances of this interface implement Emulators that are run as a java class rather than an executable. Java based emulators must provide the emulators class name and class path. In addition, virtual machine and debugger arguments may be provided.

Note: This class/interface is part of an interim API that is still under development and expected to change before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken as the API evolves.

Copyright (c) 2003 Craig Setera
All Rights Reserved.
Licensed under the Eclipse Public License - v 1.0


$Revision: 1.4 $
$Date: 2005/04/02 22:10:37 $

Author:
Craig Setera

Method Summary
 java.lang.String[] addDebugVMArguments(java.lang.String[] arguments, int port)
          Add debug-specific arguments to the specified VM arguments.
 java.lang.String getClassName(org.eclipse.debug.core.ILaunchConfiguration configuration)
          Return the name of the emulator class.
 java.lang.String[] getClasspath(org.eclipse.debug.core.ILaunchConfiguration configuration)
          Return the classpath entries necessary to launch this emulator.
 java.lang.String getVMArguments(org.eclipse.debug.core.ILaunchConfiguration configuration)
          Return the arguments to be specified to the virtual machine.
 
Methods inherited from interface eclipseme.core.model.IEmulator
getArguments, getDevices, isDebugServer, isPredeploymentRequired
 
Methods inherited from interface eclipseme.core.model.IPlatformComponent
addDependentComponent, getDependentComponents, getIdentifier, getName, getPersistenceDelegate, getVersion, hasDependentComponents, isDerived, removeDependentComponent
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

addDebugVMArguments

public java.lang.String[] addDebugVMArguments(java.lang.String[] arguments,
                                              int port)
                                       throws org.eclipse.core.runtime.CoreException
Add debug-specific arguments to the specified VM arguments.

Parameters:
arguments - the arguments without the debug arguments
port - the port on which the debugger will listen
Returns:
the new VM arguments augmented with the debug arguments
Throws:
org.eclipse.core.runtime.CoreException

getClasspath

public java.lang.String[] getClasspath(org.eclipse.debug.core.ILaunchConfiguration configuration)
                                throws org.eclipse.core.runtime.CoreException
Return the classpath entries necessary to launch this emulator.

Parameters:
configuration - the launch configuration being emulated
Returns:
the classpath entries for launching the emulator
Throws:
org.eclipse.core.runtime.CoreException

getClassName

public java.lang.String getClassName(org.eclipse.debug.core.ILaunchConfiguration configuration)
                              throws org.eclipse.core.runtime.CoreException
Return the name of the emulator class.

Parameters:
configuration - the launch configuration being emulated
Returns:
the name of the emulator implementation Java class
Throws:
org.eclipse.core.runtime.CoreException

getVMArguments

public java.lang.String getVMArguments(org.eclipse.debug.core.ILaunchConfiguration configuration)
                                throws org.eclipse.core.runtime.CoreException
Return the arguments to be specified to the virtual machine.

Parameters:
configuration - the launch configuration being emulated
Returns:
the (optional) virtual machine arguments
Throws:
org.eclipse.core.runtime.CoreException