com.github.maven_nar

Class AbstractNarMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.maven_nar.AbstractNarMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDependencyMojo, AbstractResourcesMojo, NarJavahMojo, NarPackageMojo, NarSystemMojo

public abstract class AbstractNarMojo
extends org.apache.maven.plugin.AbstractMojo
implements NarConstants

Author:

Mark Donszelmann

Field Summary

Fields

Modifier and Type	Field and Description
protected File	classesDirectory
protected List<String>	classifiers List of classifiers which you want download/unpack/assemble Example ppc-MacOSX-g++, x86-Windows-msvc, i386-Linux-g++.
protected boolean	dryRun Indicates that the NAR plugin should do everything besides actually compiling or linking any source or object files.
protected String	includesType Specifies the type of include this artifact may contain -- system or local (default)
protected List<Library>	libraries List of libraries to create
protected String	libsName Name of the libraries included
protected Replay	replay
protected boolean	skip Skip running of NAR plugins (any) altogether.
protected boolean	skipRanlib Skip running ranlib if this artifact is a library

Fields inherited from interface com.github.maven_nar.NarConstants

LOG_LEVEL_DEBUG, LOG_LEVEL_ERROR, LOG_LEVEL_INFO, LOG_LEVEL_VERBOSE, LOG_LEVEL_WARNING, NAR, NAR_AOL, NAR_EXTENSION, NAR_NO_ARCH, NAR_ROLE_HINT, NAR_TYPE, REPLAY_COMPILE_NAME, REPLAY_LINK_NAME, REPLAY_TEST_COMPILE_NAME, REPLAY_TEST_LINK_NAME

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractNarMojo()

Method Summary

Modifier and Type	Method and Description
protected void	createReplayDirs()
void	execute()
protected AOL	getAOL()
protected String	getArchitecture()
protected File	getBasedir()
protected String	getIncludesType()
protected Javah	getJavah()
protected File	getJavaHome(AOL aol)
protected NarLayout	getLayout()
protected List<Library>	getLibraries()
protected String	getLibsName()
protected Linker	getLinker()
protected org.apache.maven.project.MavenProject	getMavenProject()
Msvc	getMsvc()
protected NarInfo	getNarInfo()
protected NARVersionInfo	getNARVersionInfo()
protected String	getOS()
protected String	getOutput(boolean versioned)
protected File	getOutputDirectory()
Replay	getReplay()
protected File	getTargetDirectory()
protected File	getTestTargetDirectory()
protected File	getTestUnpackDirectory()
protected File	getUnpackDirectory()
String	getWindowsMsvcDir()
String	getWindowsMsvcVersion()
String	getWindowsSdkDir()
String	getWindowsSdkVersion()
protected boolean	isDryRun()
protected boolean	isSkipRanlib()
abstract void	narExecute()
protected void	setDryRun(boolean dryRun)
void	setReplay(Replay replay)
protected void	validate()

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

skip

@Parameter(property="nar.skip",
           defaultValue="false")
protected boolean skip

Skip running of NAR plugins (any) altogether.

classesDirectory

@Parameter(property="project.build.outputDirectory",
           readonly=true)
protected File classesDirectory

classifiers

@Parameter
protected List<String> classifiers

List of classifiers which you want download/unpack/assemble Example ppc-MacOSX-g++, x86-Windows-msvc, i386-Linux-g++. Not setting means all.

libraries

@Parameter
protected List<Library> libraries

List of libraries to create

libsName

@Parameter
protected String libsName

Name of the libraries included

skipRanlib

@Parameter(defaultValue="false",
           required=true)
protected boolean skipRanlib

Skip running ranlib if this artifact is a library

includesType

@Parameter(defaultValue="local",
           required=true)
protected String includesType

Specifies the type of include this artifact may contain -- system or local (default)

dryRun

@Parameter(defaultValue="false",
           required=true)
protected boolean dryRun

Indicates that the NAR plugin should do everything besides actually compiling or linking any source or object files. Typically used in conjunction with "replay" functionality.

replay

@Parameter
protected Replay replay

Constructor Detail

AbstractNarMojo

public AbstractNarMojo()

Method Detail

getWindowsMsvcVersion

public String getWindowsMsvcVersion()

getWindowsMsvcDir

public String getWindowsMsvcDir()

getWindowsSdkVersion

public String getWindowsSdkVersion()

getWindowsSdkDir

public String getWindowsSdkDir()

execute

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

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getAOL

protected final AOL getAOL()
                    throws org.apache.maven.plugin.MojoFailureException,
                           org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getArchitecture

protected final String getArchitecture()

getBasedir

protected final File getBasedir()

getJavah

protected final Javah getJavah()

getJavaHome

protected final File getJavaHome(AOL aol)
                          throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getLayout

protected final NarLayout getLayout()
                             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getLibraries

protected final List<Library> getLibraries()

getLinker

protected final Linker getLinker()

getNARVersionInfo

protected final NARVersionInfo getNARVersionInfo()

getMavenProject

protected final org.apache.maven.project.MavenProject getMavenProject()

getMsvc

public Msvc getMsvc()
             throws org.apache.maven.plugin.MojoFailureException,
                    org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getNarInfo

protected NarInfo getNarInfo()
                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getOS

protected final String getOS()

getOutput

protected final String getOutput(boolean versioned)
                          throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getLibsName

protected final String getLibsName()
                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

isSkipRanlib

protected final boolean isSkipRanlib()
                              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getIncludesType

protected final String getIncludesType()
                                throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getOutputDirectory

protected final File getOutputDirectory()

getTargetDirectory

protected final File getTargetDirectory()

getTestTargetDirectory

protected final File getTestTargetDirectory()

getTestUnpackDirectory

protected final File getTestUnpackDirectory()

getUnpackDirectory

protected File getUnpackDirectory()

isDryRun

protected boolean isDryRun()

setDryRun

protected void setDryRun(boolean dryRun)

narExecute

public abstract void narExecute()
                         throws org.apache.maven.plugin.MojoFailureException,
                                org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

validate

protected final void validate()
                       throws org.apache.maven.plugin.MojoFailureException,
                              org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getReplay

public Replay getReplay()

setReplay

public void setReplay(Replay replay)

createReplayDirs

protected void createReplayDirs()