org.eclipse.jet.transform
Interface IJETBundleManager
-
public interface IJETBundleManager
Define the interface to the manager for loading/unloading and describing JET transform bundles.
getAllJETBundleDescriptors
IJETBundleDescriptor[] getAllJETBundleDescriptors()
- Return descriptions of all available JET transforms.
-
-
Returns:
- an possibily empty array.
getDescriptor
IJETBundleDescriptor getDescriptor(java.lang.String id)
- Return the descriptor for a given JET transform.
-
-
Parameters:
-
id
- the transform (plug-in) id.
-
Returns:
- the descriptor or
null
.
getDescriptorForProject
IJETBundleDescriptor getDescriptorForProject(java.lang.String name)
- Return the descriptor for the give JET project
-
-
Parameters:
-
name
- the project name.
-
Returns:
- the descriptor or
null
.
getProjectForId
java.lang.String getProjectForId(java.lang.String id)
- Return the Workspace project name for the given JET transform id. If the transform does
not reside in a Workspace project, then null is returned.
-
-
Parameters:
-
id
- the transform id
-
Returns:
- the project name or
null
.
run
void run(java.lang.String id,
IJETRunnable runnable,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.osgi.framework.BundleException
- Load the specified JET transform, execute an
IJETRunnable
, and then ensure the transform is unloaded again.
-
-
Parameters:
-
id
- the transform id -
runnable
- a runnable -
monitor
- a progress monitor
-
Throws:
-
org.osgi.framework.BundleException
- TODO
connect
void connect(java.lang.String id,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.osgi.framework.BundleException
- Record a connection to the specified JET transform bundle. If this is the first connection, the bundle is
loaded.
-
-
Parameters:
-
id
- the transform id -
monitor
- a progress monitor
-
Throws:
-
org.osgi.framework.BundleException
- TODO
disconnect
void disconnect(java.lang.String id)
- Record a disconnection fromt he specified JET transform bundle. If this is the last connection, the bundle
is unloaded.
-
-
Parameters:
-
id
- the transform id
getTemplateLoader
JET2TemplateLoader getTemplateLoader(java.lang.String id)
throws org.osgi.framework.BundleException
- Return the
JET2TemplateLoader
instance for the specified JET Transform. A call to this method
must be bracketed by calls to
connect(String, IProgressMonitor)
and
disconnect(String)
.
-
-
Parameters:
-
id
- the JET transform
-
Returns:
- the template loader instance
-
Throws:
-
org.osgi.framework.BundleException
- TODO
getAllTransformIds
java.lang.String[] getAllTransformIds()
- Return an array of transform available ids.
-
-
Returns:
- a possibly empty array of strings.