zserio.ant

Class ZserioTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

zserio.ant.ZserioTask

All Implemented Interfaces:

java.lang.Cloneable

public final class ZserioTask
extends org.apache.tools.ant.Task

An ant task that handles code generation step in ant.

With the contained classpath element the task solves a severe issue:

Zserio is loaded during execution time of this target rather than ant's bootstrapping. This has a simple reason: Ant loads all its classes during bootstrapping. If we would just use ant's classpath, we could not load zserio since it is created by the task just before test-classes are called. We avoid this situation by allowing the task to have its own classpath.

Supported syntax:

 <zserio srcPath="src/path" srcFile="zs/all.zs" ignoreError="true" extraArgs="-option1 -option2">
     <arg name="cmdlineOption" value="value"/>
     <arg name="anotherOption"/>
     <classpath>
         path-like-structure
     </classpath>
 </zserio>

Supported attributes of the zserio task:

srcPath="path"
Path to source files.

srcFile="file"
Path to the input file, relative to srcPath.

ignoreError="true"
Do not report Zserio compilation error to Ant. Default is false.

extraArgs="-option1 -option2"
Extra zserio options in the same format as given by command line.

The options "srcPath" and "srcFile" are required. All the others are optional and can occur in any combination.

Supported children nodes:

<arg name="name" value="value"/>
Optional. Adds a custom option of the form "-name=value" or "-name" if value is not specified.

<classpath>path-like-structure</classpath>
Optional. Classpath used to locate and run Zserio Tool. It must include both the zserio_core.jar and all the required libraries (e.g. antlr.jar) and plugins (e.g. zserio_java.jar).

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
ZserioTask()

Method Summary

Modifier and Type	Method and Description
void	addClasspath(org.apache.tools.ant.types.Path classpath)
ZserioTask	clone()
Argument	createArg()
void	execute() This method is called from ant to execute the task.
void	setExtraArgs(java.lang.String extraArgs)
void	setIgnoreError(boolean ignoreError)
void	setSrcFile(java.lang.String srcFile)
void	setSrcPath(java.io.File srcPath)

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

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

ZserioTask

public ZserioTask()

Method Detail

clone

public ZserioTask clone()
                 throws java.lang.CloneNotSupportedException

Overrides:

clone in class org.apache.tools.ant.ProjectComponent

Throws:

java.lang.CloneNotSupportedException

setSrcFile

public void setSrcFile(java.lang.String srcFile)

setSrcPath

public void setSrcPath(java.io.File srcPath)

setIgnoreError

public void setIgnoreError(boolean ignoreError)

setExtraArgs

public void setExtraArgs(java.lang.String extraArgs)

addClasspath

public void addClasspath(org.apache.tools.ant.types.Path classpath)

createArg

public Argument createArg()

execute

public void execute()
             throws org.apache.tools.ant.BuildException

This method is called from ant to execute the task.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException