org.eclipse.emf.ant.taskdefs.codegen
Class JETEmitterTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.eclipse.emf.ant.taskdefs.EMFTask
              extended by org.eclipse.emf.ant.taskdefs.codegen.JETTask
                  extended by org.eclipse.emf.ant.taskdefs.codegen.JETEmitterTask
All Implemented Interfaces:
java.lang.Cloneable

public class JETEmitterTask
extends JETTask

Exposes some functionalities available on the JETEmitter class.

This task is supposed to be executed by a Eclipse driver with the org.eclipse.emf.ant plugin. It is neither necessary to use Ant's task TaskDef to declare this task in a script nor to change the Ant's runtime classpath.

The following command line will start a headless Eclipse instance and run the specified Ant script.

eclipseDir/eclipse -noSplash -data worspaceDir -application org.eclipse.ant.core.antRunner -buildfile antScript

In Windows you should execute eclipsec instead of eclipse in order to have access to the Ant build script console output.

You can also use the Eclipse UI to execute an Ant script containing this task by right-clicking the script and selecting Run As > Ant Build... > JRE > "Run in the same JRE as the workspace".

Usage examples:

 <emf.JETEmitter templateURI="http://www.example.com/jetTemplate.txtjet"
                 newFile="c:\output.txt"/>
 
 <emf.JETEmitter templateFile="jetTemplate.txtjet"
                 newFile="c:\output.txt"/>
 
 <emf.JETEmitter templateURI="d:\templates\jetTemplate.txtjet"
                 newFile="c:\output.txt">
     <variable name="MY_VAR" pluginID="com.myplugin;/>
     <variable name="JUNIT_HOME" pluginID="org.eclipse.jdt.junit;/>
 </emf.JETEmitter>
 

Since:
2.1.0

Nested Class Summary
static class JETEmitterTask.Variable
           
 
Field Summary
 
Fields inherited from class org.eclipse.emf.ant.taskdefs.codegen.JETTask
newFile, templateFile, templateURI
 
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location
 
Constructor Summary
JETEmitterTask()
           
 
Method Summary
protected  void checkAttributes()
          All the attribute checks should be performed in this method.
protected  JETEmitter createJETEmitter()
           
 JETEmitterTask.Variable createVariable()
           
protected  void doExecute()
          Performs the task specific code.
protected  void invokeEmitter(JETEmitter emitter)
           
 void setArgument(java.lang.Object argument)
           
 void setArgumentClass(java.lang.Class<?> argumentClass)
           
 void setProject(java.lang.String project)
           
 
Methods inherited from class org.eclipse.emf.ant.taskdefs.codegen.JETTask
getTemplateURIAsString, setNewFile, setTemplateFile, setTemplateURI
 
Methods inherited from class org.eclipse.emf.ant.taskdefs.EMFTask
assertTrue, execute, getProgressMonitor
 
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JETEmitterTask

public JETEmitterTask()
Method Detail

setProject

public void setProject(java.lang.String project)

createVariable

public JETEmitterTask.Variable createVariable()

setArgument

public void setArgument(java.lang.Object argument)

setArgumentClass

public void setArgumentClass(java.lang.Class<?> argumentClass)

checkAttributes

protected void checkAttributes()
                        throws org.apache.tools.ant.BuildException
Description copied from class: EMFTask
All the attribute checks should be performed in this method.

Overrides:
checkAttributes in class JETTask
Throws:
org.apache.tools.ant.BuildException

doExecute

protected void doExecute()
                  throws java.lang.Exception
Description copied from class: EMFTask
Performs the task specific code.

Specified by:
doExecute in class EMFTask
Throws:
java.lang.Exception

createJETEmitter

protected JETEmitter createJETEmitter()
                               throws JETException
Throws:
JETException

invokeEmitter

protected void invokeEmitter(JETEmitter emitter)
                      throws JETException,
                             java.io.IOException,
                             java.lang.InstantiationException,
                             java.lang.IllegalAccessException
Throws:
JETException
java.io.IOException
java.lang.InstantiationException
java.lang.IllegalAccessException

Copyright 2001-2006 IBM Corporation and others.
All Rights Reserved.