Package com.arjuna.orbportability.common.ant

Class IDLCompiler

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

com.arjuna.orbportability.common.ant.IDLCompiler

All Implemented Interfaces:

Cloneable

public class IDLCompiler
extends org.apache.tools.ant.Task

Ant task to compile IDL across multiple ORB's. This task uses a definitions file (idl-compiler-definitions.xml) which defines how to call each of the supported IDL compilers. For each compiler you specify a number of parameters and whether they are required for this IDL compiler. You then call this ant task and pass it a comma separated list of parameters which it then maps to the IDL compiler specific parameters.

Author:

Richard A. Begg

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	IDLCompiler.BuildListParser
class	IDLCompiler.IDLCompilerDetails
class	IDLCompiler.InputStreamFileWriter

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_buildList
protected boolean	_debugOn
protected String	_destinationDirectory
protected String	_filename
protected org.apache.tools.ant.types.FileSet	_fileSet
protected Hashtable	_idlCompilerDefinitions
protected String	_orb
protected String	_packageName
protected String	_parameters
protected boolean	_verbose

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	Description
IDLCompiler()

Method Summary

Modifier and Type	Method	Description
protected boolean	childrenContainsSubParam(Node n)
void	execute()	Called by the project to let the task do its work.
protected void	parseIDLCompilerDefinitionsFile()	Parse the IDL compiler definitions file.
boolean	processIDL(IDLCompiler.IDLCompilerDetails idlCompiler, String filename, String packageName, String destDir, String mappings)
void	setBuildlist(String buildList)
final void	setDebug(String debug)
final void	setDestdir(String destDir)
final void	setFilename(String filename)
final void	setOrb(String orb)
final void	setPackage(String packageName)
final void	setParameters(String parameters)
final void	setVerbose(String verbose)
protected String	stripDirectory(String filename)

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

Field Details

_parameters

protected String _parameters

_orb

protected String _orb

_idlCompilerDefinitions

protected Hashtable _idlCompilerDefinitions

_filename

protected String _filename

_destinationDirectory

protected String _destinationDirectory

_packageName

protected String _packageName

_buildList

protected String _buildList

_debugOn

protected boolean _debugOn

_verbose

protected boolean _verbose

_fileSet

protected org.apache.tools.ant.types.FileSet _fileSet

Constructor Details

IDLCompiler

public IDLCompiler()

Method Details

setDebug

public final void setDebug(String debug)

setVerbose

public final void setVerbose(String verbose)

setDestdir

public final void setDestdir(String destDir)

setBuildlist

public void setBuildlist(String buildList)

setPackage

public final void setPackage(String packageName)

setParameters

public final void setParameters(String parameters)

setFilename

public final void setFilename(String filename)

setOrb

public final void setOrb(String orb)

childrenContainsSubParam

protected boolean childrenContainsSubParam(Node n)

parseIDLCompilerDefinitionsFile

protected void parseIDLCompilerDefinitionsFile()
                                        throws org.apache.tools.ant.BuildException

Parse the IDL compiler definitions file.

Throws:

org.apache.tools.ant.BuildException

stripDirectory

protected String stripDirectory(String filename)

execute

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

Description copied from class: org.apache.tools.ant.Task

Called by the project to let the task do its work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running "ant target1 target2" will run all tasks in target3 twice.

Overrides:

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

Throws:

org.apache.tools.ant.BuildException - if something goes wrong with the build.

processIDL

public boolean processIDL(IDLCompiler.IDLCompilerDetails idlCompiler,
 String filename,
 String packageName,
 String destDir,
 String mappings)