|
Mobile Tools for Java Release 1.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IMetaData
Implementors of the IMetaData interface must provide a way to store and retrieve IMTJProject related Metadata.
Each IMTJProject
may have an specialized type of IMetaData
implementation. For example, IMidletSuiteProject
's uses an
IMIDPMetaData
implementation to store it's metadata.
For retrieving the IMetaData implementation referent to a specific
IMTJProject type, clients must use
MTJCore#createMetaData(org.eclipse.core.resources.IProject, ProjectType)
method from the MTJCore facade.
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.
Field Summary | |
---|---|
static String |
METADATA_FILE
The metadata file name for IMTJProject projects. |
Method Summary | |
---|---|
MTJRuntimeList |
getRuntimeList()
Return the list of runtimes that are associated to the project. |
Properties |
getSDKProviderMetaData(String sdkId)
Retrieve a Properties file of vendor-specific meta data associated with the IMTJProject. |
ISignatureProperties |
getSignatureProperties()
Returns the container class that holds the various project-specific properties relating to potential signing operations. |
Version |
getVersion()
Returns the version of the Metadata file. |
void |
saveMetaData()
Save the current metadata state to the file system. |
void |
setMTJRuntimeList(MTJRuntimeList runtimeList)
Set the list of runtimes that are associated to the project. |
void |
setSDKProviderMetaData(String sdkId,
Properties metaData)
Set a Properties file of meta data to be associated with an IMTJProject. |
void |
setSignatureProperties(ISignatureProperties signatureProperties)
Sets the container class that holds the various project-specific properties relating to potential signing operations. |
Field Detail |
---|
static final String METADATA_FILE
IMTJProject
projects.
Method Detail |
---|
MTJRuntimeList getRuntimeList()
If no list of runtimes was set previously, this method will create a new empty MTJRuntimeList and associate it to the project.
ISignatureProperties getSignatureProperties()
ISignatureProperties
instance for use in signing
operations.Version getVersion()
void saveMetaData() throws CoreException
CoreException
- if this method fails to save the metadata file.void setSDKProviderMetaData(String sdkId, Properties metaData) throws IllegalArgumentException
A example use case is to save project level user preferences associated with a vendor-supplied JAD editor page.
The Properties file is not cloned. The SDK provider may set the Properties files once and continue to make changes to it. Values will be persisted the next time saveMetaData() is called.
sdkId
- Unique identifier for the SDK. If meta data associated with
the ID is already set, the old meta data is replaced with the new.metaData
- A Properties file of arbitrary vendor-defined values.
Passing in null is allowed and will 'erase' the meta data for that ID.
IllegalArgumentException
- if sdkId is null or empty.Properties getSDKProviderMetaData(String sdkId) throws IllegalArgumentException
The Properties file is not cloned and is therefore mutable. The SDK provider may continue to make changes to it. Values will be persisted the next time saveMetaData() is called.
sdkId
- Unique identifier for the SDK.
IllegalArgumentException
- if sdkId is null or empty.void setMTJRuntimeList(MTJRuntimeList runtimeList) throws IllegalArgumentException
If a null
runtime is given, this method must throws an
IllegalArgumentException. A null
runtime list would make the
MTJ build process fail when building the IMTJProject
resources.
runtimeList
- the list of runtimes that are associated to the
project.
IllegalArgumentException
- if null
was passed as the
runtime list.void setSignatureProperties(ISignatureProperties signatureProperties)
signatureProperties
- the project-specific properties for use in
signing operations.
|
Mobile Tools for Java Release 1.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |