org.bytedeco.javacpp.tools

Class BuildMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.bytedeco.javacpp.tools.BuildMojo

All Implemented Interfaces:

ContextEnabled, Mojo

public class BuildMojo
extends AbstractMojo

A Maven Mojo to call the Builder (C++ header file -> Java class -> C++ JNI -> native library). Can also be considered as an example of how to use the Builder programmatically.

Author:

Arnaud Nauwynck, Samuel Audet

Is defined by the goal name:

build

Is bound to the specified phase of the standard build lifecycle:

process-classes

Field Summary

Fields

Modifier and Type	Field and Description
private String	classOrPackageName Process only this class or package (suffixed with .* or .**)
private String[]	classOrPackageNames Process only these classes or packages (suffixed with .* or .**)
private String	classPath Load user classes from classPath
private String[]	classPaths Load user classes from classPaths
private boolean	compile Compile and delete the generated .cpp files
private String[]	compilerOptions Pass compilerOptions directly to compiler
private boolean	copyLibs Copy to output directory dependent libraries (link and preload)
private Map<String,String>	environmentVariables Environment variables added to the compiler subprocess
private boolean	header Generate header file with declarations of callbacks functions
private String	includePath Add the path to the "platform.includepath" property.
private String[]	includePaths Add the paths to the "platform.includepath" property.
private String	jarPrefix Also create a JAR file named <jarPrefix>-<platform>.jar
private String	linkPath Add the path to the "platform.linkpath" property.
private String[]	linkPaths Add the paths to the "platform.linkpath" property.
private File	outputDirectory Output all generated files to outputDirectory
private String	outputName Output everything in a file named after given outputName
private String	preloadPath Add the path to the "platform.preloadpath" property.
private String[]	preloadPaths Add the paths to the "platform.preloadpath" property.
private MavenProject	project
private String	properties Load all properties from resource
private File	propertyFile Load all properties from file
private Properties	propertyKeysAndValues Set property keys to values
private boolean	skip Skip the execution.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
BuildMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
(package private) String[]	merge(String[] ss, String s)

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

Field Detail

classPath

private String classPath

Load user classes from classPath

Is defined by:

property:

classPath

default-value:

${project.build.outputDirectory}

classPaths

private String[] classPaths

Load user classes from classPaths

Is defined by:

property:

classPaths

includePath

private String includePath

Add the path to the "platform.includepath" property.

Is defined by:

property:

includePath

includePaths

private String[] includePaths

Add the paths to the "platform.includepath" property.

Is defined by:

property:

includePaths

linkPath

private String linkPath

Add the path to the "platform.linkpath" property.

Is defined by:

property:

linkPath

linkPaths

private String[] linkPaths

Add the paths to the "platform.linkpath" property.

Is defined by:

property:

linkPaths

preloadPath

private String preloadPath

Add the path to the "platform.preloadpath" property.

Is defined by:

property:

preloadPath

preloadPaths

private String[] preloadPaths

Add the paths to the "platform.preloadpath" property.

Is defined by:

property:

preloadPaths

outputDirectory

private File outputDirectory

Output all generated files to outputDirectory

Is defined by:

property:

outputDirectory

outputName

private String outputName

Output everything in a file named after given outputName

Is defined by:

property:

outputName

compile

private boolean compile

Compile and delete the generated .cpp files

Is defined by:

property:

compile

default-value:

true

header

private boolean header

Generate header file with declarations of callbacks functions

Is defined by:

property:

header

default-value:

false

copyLibs

private boolean copyLibs

Copy to output directory dependent libraries (link and preload)

Is defined by:

property:

copyLibs

default-value:

false

jarPrefix

private String jarPrefix

Also create a JAR file named <jarPrefix>-<platform>.jar

Is defined by:

property:

jarPrefix

properties

private String properties

Load all properties from resource

Is defined by:

property:

properties

propertyFile

private File propertyFile

Load all properties from file

Is defined by:

property:

propertyFile

propertyKeysAndValues

private Properties propertyKeysAndValues

Set property keys to values

Is defined by:

property:

propertyKeysAndValues

classOrPackageName

private String classOrPackageName

Process only this class or package (suffixed with .* or .**)

Is defined by:

property:

classOrPackageName

classOrPackageNames

private String[] classOrPackageNames

Process only these classes or packages (suffixed with .* or .**)

Is defined by:

property:

classOrPackageNames

environmentVariables

private Map<String,String> environmentVariables

Environment variables added to the compiler subprocess

Is defined by:

property:

environmentVariables

compilerOptions

private String[] compilerOptions

Pass compilerOptions directly to compiler

Is defined by:

property:

compilerOptions

skip

private boolean skip

Skip the execution.

Is defined by:

property:

skip

default-value:

false

project

private MavenProject project

Is defined by:

default-value:

${project}

Is readonly.

Is required.

Constructor Detail

BuildMojo

public BuildMojo()

Method Detail

merge

String[] merge(String[] ss,
             String s)

execute

public void execute()
             throws MojoExecutionException

Throws:

MojoExecutionException