org.eclipse.mtj.core.sdk.device
Interface IDevice

All Superinterfaces:

IPersistable

All Known Subinterfaces:

IMIDPDevice

public interface IDevice
extends IPersistable

The device interface specifies the representation of an emulated device. Each instance of a SDK must provide a list of emulated devices that implement this interface.

EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is no guarantee that this API will work or that it will remain the same. Please do not use this API without consulting with the MTJ team.

Since:

1.0

See Also:

IDevice

Method Summary

IDeviceClasspath	getClasspath() Return the deviceClasspath provided by this device.
String	getDescription() Return the displayable description of this device.
Properties	getDeviceProperties() Return the properties associated with this device.
String	getLaunchCommand(LaunchEnvironment launchEnvironment, IProgressMonitor monitor) Return the command-line arguments for launching this device given the specified launch environment.
String	getName() Return the name of this device.
String	getSDKName() Return the name of the device group to which this device belongs.
boolean	isDebugServer() Return a boolean describing whether this device wants to act as a debug server rather than attaching to the debugger as a client.
void	setName(String name) Set the name of this device.

Methods inherited from interface org.eclipse.mtj.core.persistence.IPersistable

loadUsing, storeUsing

Method Detail

getClasspath

IDeviceClasspath getClasspath()

Return the deviceClasspath provided by this device. This deviceClasspath includes all libraries for the device including configuration and profile libraries.

Returns:

getDescription

String getDescription()

Return the displayable description of this device. This description will be displayed within the user interface. If this method returns a null value, the device's name will be used as the description instead.

Returns:

the description of this device or null if the device's name should be used instead.

getDeviceProperties

Properties getDeviceProperties()

Return the properties associated with this device. The available properties will vary from emulator to emulator.

Returns:

the properties associated with this device.

getSDKName

String getSDKName()

Return the name of the device group to which this device belongs. This method must not return a null value.

Returns:

getLaunchCommand

String getLaunchCommand(LaunchEnvironment launchEnvironment,
                        IProgressMonitor monitor)
                        throws CoreException

Return the command-line arguments for launching this device given the specified launch environment.

Parameters:

launchEnvironment -

monitor -

Returns:

Throws:

CoreException

getName

String getName()

Return the name of this device. This name will be used when interacting with the emulator. This name may or may not be displayed within the user interface, dependent on whether a display name is provided by this device. This method must never return null.

Returns:

the non-null name of this device.

isDebugServer

boolean isDebugServer()

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

Returns:

if the device acts as a debug server

setName

void setName(String name)

Set the name of this device. This name will be used when interacting with the emulator. This name may or may not be displayed within the user interface, dependent on whether a display name is provided by this device. This method must never return null.

Parameters:

name - the non-null name of this device.