org.eclipse.mtj.core.project.midp
Interface IMidletSuiteProject

All Superinterfaces:

IMTJProject

public interface IMidletSuiteProject
extends IMTJProject

This interface represents access to MIDlet suite project specific information. It acts as a wrapper around an IJavaProject.

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 interface is not intended to be implemented by clients.

Field Summary

static String

APPLICATION_DESCRIPTOR_NAME The project's application descriptor.

Method Summary

IApplicationDescriptor	getApplicationDescriptor() Return an ApplicationDescriptor instance wrapped around the Application Descriptor (JAD) file for this MIDlet suite.
IFile	getApplicationDescriptorFile()
String	getJadFileName() Return the file holding the JAD file.
String	getJarFilename() Return the name to use for the JAR file.
String	getTempKeyPassword()
String	getTempKeystorePassword()
IFolder	getVerifiedClassesOutputFolder(IProgressMonitor monitor) Get the IFolder into which verified classes should be written.
IFolder	getVerifiedLibrariesOutputFolder(IProgressMonitor monitor) Get the IFolder into which verified libraries should be written.
IFolder	getVerifiedOutputFolder(IProgressMonitor monitor) Get the IFolder into which verified classes should be written.
IPreverificationError[]	preverify(IResource[] toVerify, IFolder outputFolder, IProgressMonitor monitor) Preverify the specified resources.
IPreverificationError[]	preverifyJarFile(File jarFile, IFolder outputFolder, IProgressMonitor monitor) Launch the preverification process on the specified jar file.
void	setJadFileName(String jadFileName)
void	setTempKeyPassword(String pass)
void	setTempKeystorePassword(String pass)

Methods inherited from interface org.eclipse.mtj.core.project.IMTJProject

addMTJProjectListener, createPackage, getJavaProject, getMTJRuntime, getProject, getSignatureProperties, isDeployedAppUpToDate, refreshClasspath, removeMTJProjectListener, saveMetaData, setDeployedAppFileUpToDate, setSignatureProperties

Field Detail

APPLICATION_DESCRIPTOR_NAME

static final String APPLICATION_DESCRIPTOR_NAME

The project's application descriptor.

See Also:

Constant Field Values

Method Detail

getApplicationDescriptor

IApplicationDescriptor getApplicationDescriptor()

Return an ApplicationDescriptor instance wrapped around the Application Descriptor (JAD) file for this MIDlet suite.

Returns:

the suite's application descriptor

getApplicationDescriptorFile

IFile getApplicationDescriptorFile()

Returns:

getJadFileName

String getJadFileName()

Return the file holding the JAD file. There is a chance that this file may not actually exist if the user moved the file without using the refactoring functionality.

Returns:

the java application descriptor file

getJarFilename

String getJarFilename()

Return the name to use for the JAR file.

Returns:

the jar file name

getTempKeyPassword

String getTempKeyPassword()

Returns:

getTempKeystorePassword

String getTempKeystorePassword()

Returns:

getVerifiedClassesOutputFolder

IFolder getVerifiedClassesOutputFolder(IProgressMonitor monitor)
                                       throws CoreException

Get the IFolder into which verified classes should be written.

Parameters:

monitor - progress monitor

Returns:

the verified classes output folder

Throws:

CoreException

getVerifiedLibrariesOutputFolder

IFolder getVerifiedLibrariesOutputFolder(IProgressMonitor monitor)
                                         throws CoreException

Get the IFolder into which verified libraries should be written.

Parameters:

monitor - progress monitor

Returns:

the verified libraries output folder

Throws:

CoreException

getVerifiedOutputFolder

IFolder getVerifiedOutputFolder(IProgressMonitor monitor)
                                throws CoreException

Get the IFolder into which verified classes should be written.

Parameters:

monitor - progress monitor

Returns:

the verified root output folder

Throws:

CoreException

preverify

IPreverificationError[] preverify(IResource[] toVerify,
                                  IFolder outputFolder,
                                  IProgressMonitor monitor)
                                  throws CoreException,
                                         IOException,
                                         PreverifierNotFoundException

Preverify the specified resources. Return the map of class names with preverification errors mapped to the error that was caused.

Parameters:

toVerify - the resources to be preverified

outputFolder - the folder into which the output will be written

monitor - progress monitor

Returns:

An array of errors found during preverification.

Throws:

CoreException

IOException

PreverifierNotFoundException

preverifyJarFile

IPreverificationError[] preverifyJarFile(File jarFile,
                                         IFolder outputFolder,
                                         IProgressMonitor monitor)
                                         throws CoreException,
                                                IOException,
                                                PreverifierNotFoundException

Launch the preverification process on the specified jar file.

Parameters:

jarFile - The jar file to be preverified.

outputFolder - The folder into which the output is to be placed.

monitor - Progress monitor

Returns:

An array of errors found during preverification.

Throws:

CoreException

IOException

PreverifierNotFoundException

setJadFileName

void setJadFileName(String jadFileName)

setTempKeyPassword

void setTempKeyPassword(String pass)

Parameters:

pass -

setTempKeystorePassword

void setTempKeystorePassword(String pass)

Parameters:

pass -