eclipseme.core.model
Interface IEmulator

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IPlatformComponent

All Known Subinterfaces:

IExecutableEmulator, IJavaBasedEmulator

All Known Implementing Classes:

AbstractEmulator

public interface IEmulator

extends IPlatformComponent

Required interface for emulator implementations. Emulator instances are provided by the platform definition. When launching via an emulator, this interface is queried for the appropriate command-line arguments to accomplish that launching.

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-2005 Craig Setera
All Rights Reserved.
Licensed under the Eclipse Public License - v 1.0

$Revision: 1.5 $
$Date: 2005/07/07 02:36:57 $

Author:

Craig Setera

Method Summary

java.lang.String	getArguments(org.eclipse.debug.core.ILaunchConfiguration configuration, boolean debugMode, int debugPort) Return the arguments to be sent to the emulator.
IDevice[]	getDevices() Get the devices available via this emulator.
boolean	isDebugServer() Return a boolean describing whether this emulator wants to act as a debug server rather than attaching to the debugger as a client.
boolean	isPredeploymentRequired() Return a boolean indicating whether this emulator requires a deployed jar file to be created before emulation can be done.

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

getArguments

public java.lang.String getArguments(org.eclipse.debug.core.ILaunchConfiguration configuration,
                                     boolean debugMode,
                                     int debugPort)
                              throws org.eclipse.core.runtime.CoreException

Return the arguments to be sent to the emulator.

Parameters:

configuration - the launch configuration in which launch information has been specified

Returns:

the arguments for starting the emulator

Throws:

org.eclipse.core.runtime.CoreException - when an error occurs accessing the launch configuration

getDevices

public IDevice[] getDevices()

Get the devices available via this emulator.

Returns:

the devices supported by this emulator

isDebugServer

public boolean isDebugServer()

Return a boolean describing whether this emulator wants to act as a debug server rather than attaching to the debugger as a client.

Returns:

if the emulator acts as a debug server

isPredeploymentRequired

public boolean isPredeploymentRequired()

Return a boolean indicating whether this emulator requires a deployed jar file to be created before emulation can be done. If this emulator requires predeployment, standard packaging (without obfuscation) will be done if the currently deployed jar file is not up to date.

Returns:

whether or not predeployment is necessary.