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

All Superinterfaces:

IPersistable

All Known Subinterfaces:

IDevice2

All Known Implementing Classes:

AbstractDevice, JavaEmulatorDevice, UEIDevice

public interface IDevice
extends IPersistable

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

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.

See Also:

IDevice

Method Summary

Classpath	getClasspath() Return the classpath provided by this device.
ILibrary	getConfigurationLibrary() Return the library that provides the configuration for this device or null if no such library can be found.
String	getDescription() Return the displayable description of this device.
Properties	getDeviceProperties() Return the properties associated with this device.
String	getGroupName() Return the name of the device group to which this device belongs.
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.
IPreverifier	getPreverifier() Return the preverifier to be used to preverify classes for this device.
ILibrary	getProfileLibrary() Return the library that provides the profile for this device or null if no such library can be found.
String[]	getProtectionDomains() Return the list of protection domains specified by this device.
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.
boolean	isPredeploymentRequired() Deprecated. This method is no longer called during launch
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

Classpath getClasspath()

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

Returns:

getConfigurationLibrary

ILibrary getConfigurationLibrary()

Return the library that provides the configuration for this device or null if no such library can be found.

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.

getGroupName

String getGroupName()

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.

getPreverifier

IPreverifier getPreverifier()

Return the preverifier to be used to preverify classes for this device.

Returns:

the platform's preverifier

getProfileLibrary

ILibrary getProfileLibrary()

Return the library that provides the profile for this device or null if no such library can be found.

Returns:

getProtectionDomains

String[] getProtectionDomains()

Return the list of protection domains specified by this device. Returning null from this method will imply that this device does not support protection domains.

Returns:

the list of protection domains or null if the device does not provide any protection domains.

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

isPredeploymentRequired

boolean isPredeploymentRequired()

Deprecated. This method is no longer called during launch

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

Returns:

whether or not pre-deployment is necessary.

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.