org.codehaus.mojo.idlj

Class AbstractIDLJMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.idlj.AbstractIDLJMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

IDLJMojo, TestIDLJMojo

public abstract class AbstractIDLJMojo
extends org.apache.maven.plugin.AbstractMojo

This is abstarct class used to decrease the code needed to the creation of the compiler MOJO.

Version:

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

Author:

Anders Hessellund Jensen

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractIDLJMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	addCompileSourceRoot() Add generated sources in compile source root
void	execute() Execute the goal of the MOJO that is: compiling the IDL files
protected abstract File[]	getIncludeDirs()
protected abstract File	getOutputDirectory()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.project.MavenProjectHelper	getProjectHelper()
protected abstract File	getSourceDirectory()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractIDLJMojo

public AbstractIDLJMojo()

Method Detail

getSourceDirectory

protected abstract File getSourceDirectory()
                                    throws org.apache.maven.plugin.MojoExecutionException

Returns:

the source directory that contains the IDL files

Throws:

org.apache.maven.plugin.MojoExecutionException

getIncludeDirs

protected abstract File[] getIncludeDirs()

Returns:

the File[] of the directories to use as include directories for the compilation

getOutputDirectory

protected abstract File getOutputDirectory()
                                    throws org.apache.maven.plugin.MojoExecutionException

Returns:

the path of the directory that will contains the results of the compilation

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Execute the goal of the MOJO that is: compiling the IDL files

Throws:

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

addCompileSourceRoot

protected abstract void addCompileSourceRoot()
                                      throws org.apache.maven.plugin.MojoExecutionException

Add generated sources in compile source root

Throws:

org.apache.maven.plugin.MojoExecutionException

getProject

protected org.apache.maven.project.MavenProject getProject()

Returns:

the current MavenProject instance

getProjectHelper

protected org.apache.maven.project.MavenProjectHelper getProjectHelper()

Returns:

the current MavenProjectHelper instance