Mobile Tools for Java
Release 1.0

org.eclipse.mtj.core.project
Interface IMTJProject

All Known Subinterfaces:
IMidletSuiteProject

public interface IMTJProject

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
Restriction:
This class is not intended to be implemented by clients.

Method Summary
 void addMTJProjectListener(IMTJProjectListener projectListener)
           
 void createPackage(IProgressMonitor monitor, boolean obfuscate, boolean packageInactiveConfigs)
          Create a deployed JAR file package for this MIDlet suite project.
 IJavaProject getJavaProject()
          Return the underlying java project.
 MTJRuntimeList getMTJRuntime()
          Return the list of runtimes that are associated to the project.
 IProject getProject()
          Return the underlying project instance.
 ISignatureProperties getSignatureProperties()
          Get the ISignatureProperties associated with this MIDlet suite
 boolean isDeployedAppUpToDate()
          Return a boolean indicating whether the project's deployed Application file exists and is up to date.
 void refreshClasspath(IProgressMonitor monitor)
          Refresh the classpath for this project.
 void removeMTJProjectListener(IMTJProjectListener projectListener)
           
 void saveMetaData()
          Save the MIDlet suite metadata.
 void setDeployedAppFileUpToDate(boolean upToDate)
          Set the flag indicating whether or not the deployed jar file for this MIDlet suite project is currently up to date.
 void setSignatureProperties(ISignatureProperties props)
          Set the ISignatureProperties to use for this MIDlet suite
 

Method Detail

addMTJProjectListener

void addMTJProjectListener(IMTJProjectListener projectListener)
Parameters:
projectListener -

createPackage

void createPackage(IProgressMonitor monitor,
                   boolean obfuscate,
                   boolean packageInactiveConfigs)
                   throws CoreException
Create a deployed JAR file package for this MIDlet suite project.

Parameters:
monitor - progress monitor
obfuscate - a boolean indicating whether to obfuscate the resulting packaged code.
packageInactiveConfigs - - a boolean indicating whether to package all configurations (including inactive configurations) or just package active configuration.
Throws:
CoreException

refreshClasspath

void refreshClasspath(IProgressMonitor monitor)
                      throws CoreException
Refresh the classpath for this project.

Parameters:
monitor -
Throws:
CoreException

getJavaProject

IJavaProject getJavaProject()
Return the underlying java project.

Returns:
the underlying java project

getMTJRuntime

MTJRuntimeList getMTJRuntime()
Return the list of runtimes that are associated to the project. From the list it is possible to read each runtime and information such as the device of each runtime

Returns:
MTJRuntimeList list of MTJRuntime

getProject

IProject getProject()
Return the underlying project instance.

Returns:
the underlying project

getSignatureProperties

ISignatureProperties getSignatureProperties()
                                            throws CoreException
Get the ISignatureProperties associated with this MIDlet suite

Returns:
the currently associated ISignatureProperties
Throws:
CoreException

isDeployedAppUpToDate

boolean isDeployedAppUpToDate()
                              throws CoreException
Return a boolean indicating whether the project's deployed Application file exists and is up to date.

Returns:
whether the deployed jar file is currently up to date.
Throws:
CoreException - if there is a problem retrieving the information.

removeMTJProjectListener

void removeMTJProjectListener(IMTJProjectListener projectListener)
Parameters:
projectListener -

saveMetaData

void saveMetaData()
                  throws CoreException
Save the MIDlet suite metadata. Should be called after setPlatformDefinition or setSignatureProperties are called to persist the information set.

Throws:
CoreException

setDeployedAppFileUpToDate

void setDeployedAppFileUpToDate(boolean upToDate)
                                throws CoreException
Set the flag indicating whether or not the deployed jar file for this MIDlet suite project is currently up to date.

Parameters:
upToDate - whether the deployed jar file is up to date.
Throws:
CoreException - if there is a problem setting the information.

setSignatureProperties

void setSignatureProperties(ISignatureProperties props)
                            throws CoreException
Set the ISignatureProperties to use for this MIDlet suite

Parameters:
props -
Throws:
CoreException

Mobile Tools for Java
Release 1.0