public interface PluginConverter
This interface is not intended to be implemented by clients.
Modifier and Type | Method and Description |
---|---|
Dictionary<String,String> |
convertManifest(File pluginBaseLocation,
boolean compatibility,
String target,
boolean analyseJars,
Dictionary<String,String> devProperties)
Converts a plug-in/fragment manifest at the given source base location (a directory or jar file) and
generates a corresponding bundle manifest returned as a dictionary.
|
File |
convertManifest(File pluginBaseLocation,
File bundleManifestLocation,
boolean compatibilityManifest,
String target,
boolean analyseJars,
Dictionary<String,String> devProperties)
Converts a plug-in/fragment manifest at the given source base location (a directory or jar file) and
generates a corresponding bundle manifest at the given default target location (a file).
|
void |
writeManifest(File generationLocation,
Dictionary<String,String> manifestToWrite,
boolean compatibilityManifest)
Construct a bundle manifest file from the given dictionary and write it out to the
specified location in the file system.
|
File convertManifest(File pluginBaseLocation, File bundleManifestLocation, boolean compatibilityManifest, String target, boolean analyseJars, Dictionary<String,String> devProperties) throws PluginConversionException
pluginBaseLocation
- the base location for the plug-in/fragment manifest to be converted
(a directory or jar file, e.g. the plug-in install location)bundleManifestLocation
- the location for the bundle manifest to be generated
(including the file name).compatibilityManifest
- a boolean indicating if the manifest should contain headers to run
in backward compatibilitytarget
- a string indicating the version of the runtime for which the manifest generated is targetedanalyseJars
- a boolean indicating if the code jars of the given plugin must be analysed. When set to false the Export-Package header will not be set in the bundle manifest.devProperties
- a dictionary of development time classpath properties. The dictionary contains a mapping from plugin id to development
time classpath. A value of null
indicates that the default development time classpath properties will be used.null
otherwise.PluginConversionException
- if an error occurs while converting the manifestDictionary<String,String> convertManifest(File pluginBaseLocation, boolean compatibility, String target, boolean analyseJars, Dictionary<String,String> devProperties) throws PluginConversionException
pluginBaseLocation
- the base location for the plug-in/fragment manifest to be converted
(a directory or jar file, e.g. the plug-in install location)compatibility
- a boolean indicating if the manifest should contain headers to run
in backward compatibilitytarget
- a string indicating the version of the runtime for which the manifest generated is targetedanalyseJars
- a boolean indicating if the code jars of the given plugin must be analysed. When set to false the Export-Package header will not be set in the bundle manifest.devProperties
- a dictionary of development time classpath properties. The dictionary contains a mapping from plugin id to development
time classpath. A value of null
indicates that the default development time classpath properties will be used.null
otherwisePluginConversionException
- if an error occurs while converting the manifestvoid writeManifest(File generationLocation, Dictionary<String,String> manifestToWrite, boolean compatibilityManifest) throws PluginConversionException
If the compatibilityManifest
parameter is true
then
the generated manifest will include the necessary headers to all the manifest to be
run in backwards compatibility mode.
generationLocation
- the location for the bundle manifest to be writtenmanifestToWrite
- the dictionary to write into generationLocation filecompatibilityManifest
- a boolean indicating if the file should contain headers to allow
running in backward compatibility modePluginConversionException
- if an error occurs while writing the given manifestCopyright © 2007–2018 The Apache Software Foundation. All rights reserved.