org.codehaus.mojo.idlj
Interface CompilerTranslator

All Known Implementing Classes:

AbstractTranslator, IdljTranslator, JacorbTranslator

public interface CompilerTranslator

This is the interface to implement in order to add a new compiler backend to this plugin

Version:

$Id: CompilerTranslator.java 9344 2009-04-03 22:25:02Z aheritier $

Author:

Anders Hessellund Jensen

Method Summary

void	invokeCompiler(String sourceDirectory, File[] includeDirs, String targetDirectory, String idlFile, Source source) This method it's used to invoke the compiler
void	setDebug(boolean debug) Enable/disable debug messages.
void	setFailOnError(boolean failOnError) Set to true to fail the build if an error occur while compiling the IDL.
void	setLog(org.apache.maven.plugin.logging.Log log) The Log that will used for the messages

Method Detail

invokeCompiler

void invokeCompiler(String sourceDirectory,
                    File[] includeDirs,
                    String targetDirectory,
                    String idlFile,
                    Source source)
                    throws org.apache.maven.plugin.MojoExecutionException

This method it's used to invoke the compiler

Parameters:

sourceDirectory - the path to the sources

includeDirs - the File[] of directories where to find the includes

targetDirectory - the path to the destination of the compilation

idlFile - the path to the file to compile

source - //TODO ???

Throws:

org.apache.maven.plugin.MojoExecutionException - the exeception is thrown whenever the compilation fails or crashes

setDebug

void setDebug(boolean debug)

Enable/disable debug messages.

Parameters:

debug - the debug to set

setLog

void setLog(org.apache.maven.plugin.logging.Log log)

The Log that will used for the messages

Parameters:

log - the log to set

setFailOnError

void setFailOnError(boolean failOnError)

Set to true to fail the build if an error occur while compiling the IDL.

Parameters:

failOnError - the failOnError to set