org.codehaus.mojo.idlj

Class AbstractTranslator

java.lang.Object

org.codehaus.mojo.idlj.AbstractTranslator

All Implemented Interfaces:

CompilerTranslator

Direct Known Subclasses:

IdljTranslator, JacorbTranslator

public abstract class AbstractTranslator
extends Object
implements CompilerTranslator

Shared capabilities for translators.

Version:

$Id: AbstractIDLJMojo.java 9189 2009-03-10 21:47:46Z aheritier $

Author:

Arnaud Heritier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractTranslator.ClassLoaderFacade An interface for loading the proper IDL compiler class.

Constructor Summary

Constructors

Constructor and Description
AbstractTranslator()

Method Summary

Modifier and Type	Method and Description
protected AbstractTranslator.ClassLoaderFacade	getClassLoaderFacade() Returns the object to use for classloading.
org.apache.maven.plugin.logging.Log	getLog()
protected void	invokeCompilerInProcess(Class<?> compilerClass, List<String> args) Invokes the configured compiler and throws an exception if anything goes wrong
boolean	isDebug()
boolean	isFailOnError()
protected static boolean	isFork() Returns true if the translator is allowed to create a new forked process.
protected abstract int	runCompiler(Class<?> compilerClass, String... arguments) Runs the IDL 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.codehaus.mojo.idlj.CompilerTranslator

invokeCompiler

Constructor Detail

AbstractTranslator

public AbstractTranslator()

Method Detail

isDebug

public boolean isDebug()

Returns:

the debug

setDebug

public void setDebug(boolean debug)

Description copied from interface: CompilerTranslator

Enable/disable debug messages.

Specified by:

setDebug in interface CompilerTranslator

Parameters:

debug - the debug to set

getLog

public org.apache.maven.plugin.logging.Log getLog()

Returns:

the log

setLog

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

Description copied from interface: CompilerTranslator

The Log that will used for the messages

Specified by:

setLog in interface CompilerTranslator

Parameters:

log - the log to set

isFailOnError

public boolean isFailOnError()

Returns:

the failOnError

setFailOnError

public void setFailOnError(boolean failOnError)

Description copied from interface: CompilerTranslator

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

Specified by:

setFailOnError in interface CompilerTranslator

Parameters:

failOnError - the failOnError to set

isFork

protected static boolean isFork()

Returns true if the translator is allowed to create a new forked process.

Returns:

true if forking is permitted

getClassLoaderFacade

protected AbstractTranslator.ClassLoaderFacade getClassLoaderFacade()

Returns the object to use for classloading.

Returns:

the appropriate loader facade

invokeCompilerInProcess

protected void invokeCompilerInProcess(Class<?> compilerClass,
                                       List<String> args)
                                throws org.apache.maven.plugin.MojoExecutionException

Invokes the configured compiler and throws an exception if anything goes wrong

Parameters:

compilerClass - the class representing the compiler to invoke

args - the arguments to pass to the compiler

Throws:

org.apache.maven.plugin.MojoExecutionException - if any error occurs

runCompiler

protected abstract int runCompiler(Class<?> compilerClass,
                                   String... arguments)
                            throws NoSuchMethodException,
                                   IllegalAccessException,
                                   InvocationTargetException

Runs the IDL compiler

Parameters:

compilerClass - the class which implements the compiler

arguments - the arguments to pass to the compiler

Returns:

the return status (a non-zero value indicates an error)

Throws:

NoSuchMethodException - if the method which should run the compiler does not exist

IllegalAccessException - if no constructor is available

InvocationTargetException - if an error occurs while invoking the compiler