Eclipse JET Guide (Galileo) - JET1TemplateManager (JET Javadoc)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jet
Class JET1TemplateManager

java.lang.Object
  
org.eclipse.jet.JET1TemplateManager

public class JET1TemplateManager
extends java.lang.Object
extends java.lang.Object

Mananger for operations that dynamically invoke JET1 templates. Manager for invoking dymanic JET1 templates. A replacement for (and simplification of) org.eclipse.emf.codegen.jet.JETEmitter. Operations implement JET1TemplateManager.ITemplateOperation and are run via run(String[], org.eclipse.jet.JET1TemplateManager.ITemplateOperation, IProgressMonitor). The operation may then dynamically load and execute templates found in the provided plug-ins via the passed JET1TemplateManager.ITemplateRunner.

Loads JET1 templates dynamically from Eclipse plug-ins and/or in workspace plug-in projects, so long as the projects were compiled with the org.eclipse.jet compiler (rather than org.eclipse.emf.codegen JET compiler).

Provisional API. This API is subject to breaking change or removal.

Nested Class Summary

static interface JET1TemplateManager.ITemplateOperation
          Protocol for a dynamic template operation.

static interface JET1TemplateManager.ITemplateRunner
          Defines the protocol for an operation that dynamically invokes JET1 templates.

Method Summary

static void run (java.lang.String[] pluginIDs, JET1TemplateManager.ITemplateOperation operation, org.eclipse.core.runtime.IProgressMonitor monitor)
          Execute a JET templates that are loaded dynamically from the provided Eclipse plug-ins.

Methods inherited from class java.lang.Object

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

Method Detail

run

public static void run(java.lang.String[] pluginIDs,
                       
JET1TemplateManager.ITemplateOperation operation,
                       org.eclipse.core.runtime.IProgressMonitor monitor)
                throws org.osgi.framework.BundleException

Execute a JET templates that are loaded dynamically from the provided Eclipse plug-ins. Each plug-in ID must be the ID of an already loaded plug-in, or of a plug-in in the Eclipse workspace. The plug-in list is search in order until a template is found.

Parameters:: pluginIDs - a non-empty list of Eclipse plug-in ids.; operation - an operation that will consume the templates; monitor - a progress monitor
Throws:: org.osgi.framework.BundleException - if one of the plug-ins cannot be loaded; java.lang.NullPointerException - if pluginIDs is null, or if any element is null; java.lang.IllegalArgumentException - if pluginIDs has zero length