com.github.maven_nar

Class Compiler

java.lang.Object

com.github.maven_nar.Compiler

Direct Known Subclasses:

C, Cpp, Fortran, IDL, Message, Resource

public abstract class Compiler
extends Object

Abstract Compiler class

Author:

Mark Donszelmann

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAIN
static String	TEST

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Compiler()

Method Summary

Modifier and Type	Method and Description
void	copyIncludeFiles(org.apache.maven.project.MavenProject mavenProject, File targetDirectory)
CompilerDef	getCompiler(String type, String output) Generates a new CompilerDef and populates it give the parameters provided.
Set<String>	getExcludes()
protected Set<String>	getExcludes(String type)
protected List<IncludePath>	getIncludePaths(String type)
Set<String>	getIncludes()
protected Set<String>	getIncludes(String type)
protected abstract String	getLanguage()
String	getName()
protected String	getPrefix()
List<File>	getSourceDirectories()
CompilerDef	getTestCompiler(String type, String output)
void	setAbstractCompileMojo(AbstractCompileMojo mojo)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAIN

public static final String MAIN

See Also:

Constant Field Values

TEST

public static final String TEST

See Also:

Constant Field Values

Constructor Detail

Compiler

protected Compiler()

Method Detail

copyIncludeFiles

public final void copyIncludeFiles(org.apache.maven.project.MavenProject mavenProject,
                                   File targetDirectory)
                            throws IOException

Throws:

IOException

getCompiler

public final CompilerDef getCompiler(String type,
                                     String output)
                              throws org.apache.maven.plugin.MojoFailureException,
                                     org.apache.maven.plugin.MojoExecutionException

Generates a new CompilerDef and populates it give the parameters provided.

Parameters:

type - - main or test library - used to determine include and exclude paths.

output - - TODO Not sure..

Returns:

CompilerDef which contains the configuration for this compiler given the type and output.

Throws:

org.apache.maven.plugin.MojoFailureException - TODO

org.apache.maven.plugin.MojoExecutionException - TODO

getExcludes

public final Set<String> getExcludes()
                              throws org.apache.maven.plugin.MojoFailureException,
                                     org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getExcludes

protected final Set<String> getExcludes(String type)
                                 throws org.apache.maven.plugin.MojoFailureException,
                                        org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getIncludePaths

protected final List<IncludePath> getIncludePaths(String type)

getIncludes

public final Set<String> getIncludes()
                              throws org.apache.maven.plugin.MojoFailureException,
                                     org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getIncludes

protected final Set<String> getIncludes(String type)
                                 throws org.apache.maven.plugin.MojoFailureException,
                                        org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getLanguage

protected abstract String getLanguage()

getName

public String getName()
               throws org.apache.maven.plugin.MojoFailureException,
                      org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getPrefix

protected final String getPrefix()
                          throws org.apache.maven.plugin.MojoFailureException,
                                 org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getSourceDirectories

public final List<File> getSourceDirectories()

getTestCompiler

public final CompilerDef getTestCompiler(String type,
                                         String output)
                                  throws org.apache.maven.plugin.MojoFailureException,
                                         org.apache.maven.plugin.MojoExecutionException

Returns:

The standard Compiler configuration with 'testOptions' added to the argument list.

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

setAbstractCompileMojo

public final void setAbstractCompileMojo(AbstractCompileMojo mojo)

toString

public String toString()

Overrides:

toString in class Object