org.codehaus.mojo.idlj

Class IdljTranslator

java.lang.Object

org.codehaus.mojo.idlj.AbstractTranslator

org.codehaus.mojo.idlj.IdljTranslator

All Implemented Interfaces:

CompilerTranslator

public class IdljTranslator
extends AbstractTranslator
implements CompilerTranslator

This class implement the CompilerTranslator for the Sun idlj IDL compiler

Version:

$Id: IdljTranslator.java 17152 2012-07-16 18:42:38Z russgold $

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.mojo.idlj.AbstractTranslator

AbstractTranslator.ClassLoaderFacade, AbstractTranslator.ClassLoaderFacadeImpl

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	AIX_IDLJ_COMPILER_NAME
private static java.lang.String	ORACLE_IDLJ_COMPILER_NAME

Constructor Summary

Constructors

Constructor and Description
IdljTranslator() Default constructor

Method Summary

Modifier and Type	Method and Description
private void	addToolsJarToPath()
static java.lang.String	fixSeparator(java.lang.String filename) Convert the provided filename from a Windows separator \\ to a unix/java separator /
static java.lang.String	getCanonicalPath(java.io.File file) Return the unique path to the resource.
private java.lang.Class<?>	getCompilerClass()
private static java.lang.String	getIDLCompilerClassName()
private java.lang.String	getToolsJarPath()
private void	invokeCompiler(java.lang.Class<?> compilerClass, java.util.List<java.lang.String> args) Invoke the specified compiler with a set of arguments
void	invokeCompiler(java.lang.String sourceDirectory, java.io.File[] includeDirs, java.lang.String targetDirectory, java.lang.String idlFile, Source source) This method it's used to invoke the compiler
private static boolean	isAix()
private boolean	isMacOSX()
private boolean	isOptionEnabled(java.lang.Boolean option)
protected int	runCompiler(java.lang.Class<?> compilerClass, java.lang.String... arguments) Runs the IDL compiler
static java.lang.String	toRelativeAndFixSeparator(java.io.File fromdir, java.io.File todir, boolean replaceSlashesWithDashes) Taken from maven-eclipse-plugin

Methods inherited from class org.codehaus.mojo.idlj.AbstractTranslator

getClassLoaderFacade, getLog, invokeCompilerInProcess, isDebug, isFailOnError, isFork, setClassLoaderFacade, setDebug, setFailOnError, setLog

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

setDebug, setFailOnError, setLog

Field Detail

AIX_IDLJ_COMPILER_NAME

private static final java.lang.String AIX_IDLJ_COMPILER_NAME

See Also:

Constant Field Values

ORACLE_IDLJ_COMPILER_NAME

private static final java.lang.String ORACLE_IDLJ_COMPILER_NAME

See Also:

Constant Field Values

Constructor Detail

IdljTranslator

public IdljTranslator()

Default constructor

Method Detail

invokeCompiler

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

This method it's used to invoke the compiler

Specified by:

invokeCompiler in interface CompilerTranslator

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 - the source tag available in the configuration tree of the maven plugin

Throws:

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

isOptionEnabled

private boolean isOptionEnabled(java.lang.Boolean option)

getCompilerClass

private java.lang.Class<?> getCompilerClass()
                                     throws org.apache.maven.plugin.MojoExecutionException

Returns:

the Class that implements the idlj compiler

Throws:

org.apache.maven.plugin.MojoExecutionException - if the search for the class fails

addToolsJarToPath

private void addToolsJarToPath()
                        throws java.net.MalformedURLException,
                               java.lang.ClassNotFoundException

Throws:

java.net.MalformedURLException

java.lang.ClassNotFoundException

getToolsJarPath

private java.lang.String getToolsJarPath()

isMacOSX

private boolean isMacOSX()

isAix

private static boolean isAix()

getIDLCompilerClassName

private static java.lang.String getIDLCompilerClassName()

Returns:

the name of the class that implements the compiler

invokeCompiler

private void invokeCompiler(java.lang.Class<?> compilerClass,
                            java.util.List<java.lang.String> args)
                     throws org.apache.maven.plugin.MojoExecutionException

Invoke the specified compiler with a set of arguments

Parameters:

compilerClass - the Class that implements the compiler

args - a List that contains the arguments to use for the compiler

Throws:

org.apache.maven.plugin.MojoExecutionException - if the compilation fail or the compiler crashes

runCompiler

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

Description copied from class: AbstractTranslator

Runs the IDL compiler

Specified by:

runCompiler in class AbstractTranslator

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:

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

java.lang.IllegalAccessException - if no constructor is available

java.lang.reflect.InvocationTargetException - if an error occurs while invoking the compiler

fixSeparator

public static java.lang.String fixSeparator(java.lang.String filename)

Convert the provided filename from a Windows separator \\ to a unix/java separator /

Parameters:

filename - file name to fix separator

Returns:

filename with all \\ replaced with /

getCanonicalPath

public static java.lang.String getCanonicalPath(java.io.File file)
                                         throws org.apache.maven.plugin.MojoExecutionException

Return the unique path to the resource.

Parameters:

file - a resource to locate

Returns:

the computed path

Throws:

org.apache.maven.plugin.MojoExecutionException - if the infrastructure detects a problem

toRelativeAndFixSeparator

public static java.lang.String toRelativeAndFixSeparator(java.io.File fromdir,
                                                         java.io.File todir,
                                                         boolean replaceSlashesWithDashes)
                                                  throws org.apache.maven.plugin.MojoExecutionException

Taken from maven-eclipse-plugin

Parameters:

fromdir - not sure

todir - what these are

replaceSlashesWithDashes - true if we need to replace slashes with dashes to accomodate the OS

Returns:

the relative path between fromdir to todir

Throws:

org.apache.maven.plugin.MojoExecutionException - thrown if an error is detected by the mojo infrastructure