eclipseme.core.model.impl
Class MidletSuiteProject

java.lang.Object
  eclipseme.core.model.impl.MidletSuiteProject

All Implemented Interfaces:

IMidletSuiteProject

public class MidletSuiteProject

extends java.lang.Object

implements IMidletSuiteProject

Implementation of the IMidletSuiteProject interface providing access to midlet suite specific information.

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:58 $

Author:

Craig Setera

Nested Class Summary

static class

MidletSuiteProject.MidletSuiteCreationRunnable Workspace runnable for creating a Midlet Suite within a project.

Field Summary

static java.lang.String	CLASSES_DIRECTORY The verified subdirectory for classes
static java.lang.String	LIBS_DIRECTORY The verified subdirectory for libraries
static org.eclipse.core.runtime.QualifiedName	PLATFORM_DEF_PROP

Method Summary

static boolean	containsJ2MEClasspathContainer(org.eclipse.jdt.core.IJavaProject javaProject) Return a boolean indicating whether the project contains the J2ME classpath container.
void	createPackage(org.eclipse.core.runtime.IProgressMonitor monitor, boolean obfuscate) Create a deployed JAR file package for this midlet suite project.
ApplicationDescriptor	getApplicationDescriptor() Return an ApplicationDescriptor instance wrapped around the Application Descriptor (JAD) file for this midlet suite.
eclipseme.core.internal.utils.ColonDelimitedProperties	getDefaultApplicationDescriptorProperties() Return the set of default application descriptor properties for this midlet suite.
java.lang.String	getJadFilename() Return the name to use for the JAD file.
java.lang.String	getJarFilename() Return the name to use for the JAR file.
org.eclipse.jdt.core.IJavaProject	getJavaProject() Return the underlying java project.
MetaData	getMetaData() Return the metadata for this midlet suite. NOTE: This method is not considered part of the API and is only available to aid the implementation.
static MidletSuiteProject.MidletSuiteCreationRunnable	getMidletSuiteCreationRunnable(org.eclipse.core.resources.IProject project, org.eclipse.jdt.core.IJavaProject javaProject, IPlatformDefinition platformDefinition) Return a runnable capable of setting up the J2ME nature on the project.
static IMidletSuiteProject	getMidletSuiteProject(org.eclipse.jdt.core.IJavaProject javaProject) Return the midlet suite project instance for the specified java project.
IPlatformDefinition	getPlatformDefinition() Get the IPlatformDefinition in use for this midlet suite.
java.lang.String	getPlatformDefinitionName() Get the name of the platform definition in use for this midlet suite.
org.eclipse.core.resources.IProject	getProject() Return the underlying project instance.
ISignatureProperties	getSignatureProperties() Get the ISignatureProperties associated with this midlet suite
java.lang.String	getTempKeyPassword()
java.lang.String	getTempKeystorePassword()
org.eclipse.core.resources.IFolder	getVerifiedClassesOutputFolder(org.eclipse.core.runtime.IProgressMonitor monitor) Get the IFolder into which verified classes should be written.
org.eclipse.core.resources.IFolder	getVerifiedLibrariesOutputFolder(org.eclipse.core.runtime.IProgressMonitor monitor) Get the IFolder into which verified libraries should be written.
org.eclipse.core.resources.IFolder	getVerifiedOutputFolder(org.eclipse.core.runtime.IProgressMonitor monitor) Get the IFolder into which verified classes should be written.
IWirelessToolkit	getWirelessToolkit() Return the wireless toolkit associated with this project.
boolean	isDeployedJarUpToDate() Return a boolean indicating whether the project's deployed jar file exists and is up to date compared with the code contained within the jar.
java.util.Map	preverify(org.eclipse.core.resources.IResource[] toVerify, org.eclipse.core.resources.IFolder outputFolder, org.eclipse.core.runtime.IProgressMonitor monitor) Preverify the specified resources.
java.util.Map	preverifyJarFile(java.io.File jarFile, org.eclipse.core.resources.IFolder outputFolder, org.eclipse.core.runtime.IProgressMonitor monitor) Launch the preverification process on the specified jar file.
void	saveMetaData() Save the midlet suite metadata.
void	setDeployedJarFileUpToDate(boolean upToDate) Set the flag indicating whether or not the deployed jar file for this midlet suite project is currently up to date.
void	setPlatformDefinition(IPlatformDefinition definition) Set the IPlatformDefinition to use for this midlet suite.
void	setSignatureProperties(ISignatureProperties props) Set the ISignatureProperties to use for this midlet suite
void	setTempKeyPassword(java.lang.String pass)
void	setTempKeystorePassword(java.lang.String pass)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASSES_DIRECTORY

public static final java.lang.String CLASSES_DIRECTORY

The verified subdirectory for classes

See Also:

Constant Field Values

LIBS_DIRECTORY

public static final java.lang.String LIBS_DIRECTORY

The verified subdirectory for libraries

See Also:

Constant Field Values

PLATFORM_DEF_PROP

public static final org.eclipse.core.runtime.QualifiedName PLATFORM_DEF_PROP

Method Detail

containsJ2MEClasspathContainer

public static boolean containsJ2MEClasspathContainer(org.eclipse.jdt.core.IJavaProject javaProject)
                                              throws org.eclipse.jdt.core.JavaModelException

Return a boolean indicating whether the project contains the J2ME classpath container.

Parameters:

javaProject - the project to be tested

Returns:

whether the project has the J2ME classpath container

Throws:

org.eclipse.jdt.core.JavaModelException

getMidletSuiteCreationRunnable

public static MidletSuiteProject.MidletSuiteCreationRunnable getMidletSuiteCreationRunnable(org.eclipse.core.resources.IProject project,
                                                                                            org.eclipse.jdt.core.IJavaProject javaProject,
                                                                                            IPlatformDefinition platformDefinition)

Return a runnable capable of setting up the J2ME nature on the project.

Returns:

a runnable that can be used to create a new midlet suite

getMidletSuiteProject

public static IMidletSuiteProject getMidletSuiteProject(org.eclipse.jdt.core.IJavaProject javaProject)

Return the midlet suite project instance for the specified java project.

Parameters:

javaProject - the Java project to retrieve the midlet suite wrapper

Returns:

the midlet suite wrapper

getApplicationDescriptor

public ApplicationDescriptor getApplicationDescriptor()

Description copied from interface: IMidletSuiteProject

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

Specified by:

getApplicationDescriptor in interface IMidletSuiteProject

Returns:

the suite's application descriptor

See Also:

IMidletSuiteProject.getApplicationDescriptor()

createPackage

public void createPackage(org.eclipse.core.runtime.IProgressMonitor monitor,
                          boolean obfuscate)
                   throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMidletSuiteProject

Create a deployed JAR file package for this midlet suite project.

Specified by:

createPackage in interface IMidletSuiteProject

Parameters:

monitor - progress monitor

obfuscate - a boolean indicating whether to obfuscate the resulting packaged code.

Throws:

org.eclipse.core.runtime.CoreException

See Also:

IMidletSuiteProject.createPackage(org.eclipse.core.runtime.IProgressMonitor, boolean)

getDefaultApplicationDescriptorProperties

public eclipseme.core.internal.utils.ColonDelimitedProperties getDefaultApplicationDescriptorProperties()

Description copied from interface: IMidletSuiteProject

Return the set of default application descriptor properties for this midlet suite.

Specified by:

getDefaultApplicationDescriptorProperties in interface IMidletSuiteProject

Returns:

a set of default application descriptor properties

See Also:

IMidletSuiteProject.getDefaultApplicationDescriptorProperties()

setPlatformDefinition

public void setPlatformDefinition(IPlatformDefinition definition)
                           throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMidletSuiteProject

Set the IPlatformDefinition to use for this midlet suite.

Specified by:

setPlatformDefinition in interface IMidletSuiteProject

Parameters:

definition - the platform definition to be associated with this midlet suite

Throws:

org.eclipse.core.runtime.CoreException

See Also:

IMidletSuiteProject.setPlatformDefinition(eclipseme.core.model.IPlatformDefinition)

getSignatureProperties

public ISignatureProperties getSignatureProperties()
                                            throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMidletSuiteProject

Get the ISignatureProperties associated with this midlet suite

Specified by:

getSignatureProperties in interface IMidletSuiteProject

Returns:

the currently associated ISignatureProperties

Throws:

org.eclipse.core.runtime.CoreException

setSignatureProperties

public void setSignatureProperties(ISignatureProperties props)

Description copied from interface: IMidletSuiteProject

Set the ISignatureProperties to use for this midlet suite

Specified by:

setSignatureProperties in interface IMidletSuiteProject

Parameters:

props -

saveMetaData

public void saveMetaData()
                  throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMidletSuiteProject

Save the midlet suite metadata. Should be called after setPlatformDefinition or setSignatureProperties are called to persist the information set.

Specified by:

saveMetaData in interface IMidletSuiteProject

Throws:

org.eclipse.core.runtime.CoreException

getTempKeystorePassword

public java.lang.String getTempKeystorePassword()

Specified by:

getTempKeystorePassword in interface IMidletSuiteProject

setTempKeystorePassword

public void setTempKeystorePassword(java.lang.String pass)

Specified by:

setTempKeystorePassword in interface IMidletSuiteProject

getTempKeyPassword

public java.lang.String getTempKeyPassword()

Specified by:

getTempKeyPassword in interface IMidletSuiteProject

setTempKeyPassword

public void setTempKeyPassword(java.lang.String pass)

Specified by:

setTempKeyPassword in interface IMidletSuiteProject

getJadFilename

public java.lang.String getJadFilename()

Description copied from interface: IMidletSuiteProject

Return the name to use for the JAD file.

Specified by:

getJadFilename in interface IMidletSuiteProject

Returns:

the java application descriptor filename

See Also:

IMidletSuiteProject.getJadFilename()

getJarFilename

public java.lang.String getJarFilename()

Description copied from interface: IMidletSuiteProject

Return the name to use for the JAR file.

Specified by:

getJarFilename in interface IMidletSuiteProject

Returns:

the jar file name

See Also:

IMidletSuiteProject.getJarFilename()

getJavaProject

public org.eclipse.jdt.core.IJavaProject getJavaProject()

Description copied from interface: IMidletSuiteProject

Return the underlying java project.

Specified by:

getJavaProject in interface IMidletSuiteProject

Returns:

the underlying java project

See Also:

IMidletSuiteProject.getJavaProject()

getMetaData

public MetaData getMetaData()

Return the metadata for this midlet suite.
NOTE: This method is not considered part of the API and is only available to aid the implementation.

Returns:

the metadata.

getPlatformDefinition

public IPlatformDefinition getPlatformDefinition()
                                          throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMidletSuiteProject

Get the IPlatformDefinition in use for this midlet suite.

Specified by:

getPlatformDefinition in interface IMidletSuiteProject

Returns:

the currently associated platform definition

Throws:

org.eclipse.core.runtime.CoreException

See Also:

IMidletSuiteProject.getPlatformDefinition()

getPlatformDefinitionName

public java.lang.String getPlatformDefinitionName()
                                           throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMidletSuiteProject

Get the name of the platform definition in use for this midlet suite.

Specified by:

getPlatformDefinitionName in interface IMidletSuiteProject

Returns:

the currently associated platform definition name

Throws:

org.eclipse.core.runtime.CoreException

See Also:

IMidletSuiteProject.getPlatformDefinitionName()

getProject

public org.eclipse.core.resources.IProject getProject()

Description copied from interface: IMidletSuiteProject

Return the underlying project instance.

Specified by:

getProject in interface IMidletSuiteProject

Returns:

the underlying project

See Also:

IMidletSuiteProject.getProject()

getVerifiedClassesOutputFolder

public org.eclipse.core.resources.IFolder getVerifiedClassesOutputFolder(org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                  throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMidletSuiteProject

Get the IFolder into which verified classes should be written.

Specified by:

getVerifiedClassesOutputFolder in interface IMidletSuiteProject

Parameters:

monitor - progress monitor

Returns:

the verified classes output folder

Throws:

org.eclipse.core.runtime.CoreException

See Also:

IMidletSuiteProject.getVerifiedClassesOutputFolder(org.eclipse.core.runtime.IProgressMonitor)

getVerifiedLibrariesOutputFolder

public org.eclipse.core.resources.IFolder getVerifiedLibrariesOutputFolder(org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                    throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMidletSuiteProject

Get the IFolder into which verified libraries should be written.

Specified by:

getVerifiedLibrariesOutputFolder in interface IMidletSuiteProject

Parameters:

monitor - progress monitor

Returns:

the verified libraries output folder

Throws:

org.eclipse.core.runtime.CoreException

See Also:

IMidletSuiteProject.getVerifiedLibrariesOutputFolder(org.eclipse.core.runtime.IProgressMonitor)

getVerifiedOutputFolder

public org.eclipse.core.resources.IFolder getVerifiedOutputFolder(org.eclipse.core.runtime.IProgressMonitor monitor)
                                                           throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMidletSuiteProject

Get the IFolder into which verified classes should be written.

Specified by:

getVerifiedOutputFolder in interface IMidletSuiteProject

Parameters:

monitor - progress monitor

Returns:

the verified root output folder

Throws:

org.eclipse.core.runtime.CoreException

See Also:

IMidletSuiteProject.getVerifiedOutputFolder(org.eclipse.core.runtime.IProgressMonitor)

getWirelessToolkit

public IWirelessToolkit getWirelessToolkit()
                                    throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMidletSuiteProject

Return the wireless toolkit associated with this project.

Specified by:

getWirelessToolkit in interface IMidletSuiteProject

Returns:

the wireless toolkit currently associated wireless toolkit

Throws:

org.eclipse.core.runtime.CoreException

See Also:

IMidletSuiteProject.getWirelessToolkit()

isDeployedJarUpToDate

public boolean isDeployedJarUpToDate()
                              throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMidletSuiteProject

Return a boolean indicating whether the project's deployed jar file exists and is up to date compared with the code contained within the jar.

Specified by:

isDeployedJarUpToDate in interface IMidletSuiteProject

Returns:

whether the deployed jar file is currently up to date.

Throws:

org.eclipse.core.runtime.CoreException - if there is a problem retrieving the information.

See Also:

IMidletSuiteProject.isDeployedJarUpToDate()

preverify

public java.util.Map preverify(org.eclipse.core.resources.IResource[] toVerify,
                               org.eclipse.core.resources.IFolder outputFolder,
                               org.eclipse.core.runtime.IProgressMonitor monitor)
                        throws org.eclipse.core.runtime.CoreException,
                               java.io.IOException

Description copied from interface: IMidletSuiteProject

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

Specified by:

preverify in interface IMidletSuiteProject

Parameters:

toVerify - the resources to be preverified

outputFolder - the folder into which the output will be written

monitor - progress monitor

Returns:

A map of class names mapped to error information. If the map is empty there were no errors registered during the preverification.

Throws:

java.io.IOException

org.eclipse.core.runtime.CoreException

See Also:

IMidletSuiteProject.preverify(org.eclipse.core.resources.IResource[], org.eclipse.core.resources.IFolder, org.eclipse.core.runtime.IProgressMonitor)

preverifyJarFile

public java.util.Map preverifyJarFile(java.io.File jarFile,
                                      org.eclipse.core.resources.IFolder outputFolder,
                                      org.eclipse.core.runtime.IProgressMonitor monitor)
                               throws org.eclipse.core.runtime.CoreException,
                                      java.io.IOException

Description copied from interface: IMidletSuiteProject

Launch the preverification process on the specified jar file.

Specified by:

preverifyJarFile in interface IMidletSuiteProject

Parameters:

jarFile - The jar file to be preverified.

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

monitor - Progress monitor

Returns:

A map of class names mapped to error information. If the map is empty there were no errors registered during the preverification.

Throws:

java.io.IOException

org.eclipse.core.runtime.CoreException

See Also:

IMidletSuiteProject.preverifyJarFile(java.io.File, org.eclipse.core.resources.IFolder, org.eclipse.core.runtime.IProgressMonitor)

setDeployedJarFileUpToDate

public void setDeployedJarFileUpToDate(boolean upToDate)
                                throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMidletSuiteProject

Set the flag indicating whether or not the deployed jar file for this midlet suite project is currently up to date.

Specified by:

setDeployedJarFileUpToDate in interface IMidletSuiteProject

Parameters:

upToDate - whether the deployed jar file is up to date.

Throws:

org.eclipse.core.runtime.CoreException - if there is a problem setting the information.

See Also:

IMidletSuiteProject.setDeployedJarFileUpToDate(boolean)