com.github.maven_nar
Interface NarLayout

All Known Implementing Classes:

AbstractNarLayout, NarLayout20, NarLayout21

public interface NarLayout

Interface to define the layout of nar files (executables, libs, include dirs) in both the repository (local, unpacked) as well as in target.

Author:

Mark Donszelmann (Mark.Donszelmann@gmail.com)

Method Summary

void	attachNars(File baseDir, org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager, org.apache.maven.project.MavenProjectHelper projectHelper, org.apache.maven.project.MavenProject project) Called to attach nars to main nar/jar file.
File	getBinDirectory(File baseDir, String artifactId, String version, String aol) Specifies where binaries are stored
File	getIncludeDirectory(File baseDir, String artifactId, String version) Specifies where includes are stored
File	getLibDirectory(File baseDir, String artifactId, String version, String aol, String type) Specifies where libraries are stored
File	getNarUnpackDirectory(File baseUnpackDirectory, File narFile) Returns the unpack directory of a specific nar file.
File	getNoArchDirectory(File baseDir, String artifactId, String version) Specifies where all the "no architecture" specific files are stored
void	prepareNarInfo(File baseDir, org.apache.maven.project.MavenProject project, NarInfo narInfo, AbstractNarMojo libraryName) Called to attach nars to main nar/jar file.
void	unpackNar(File baseDir, org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager, File file, String os, String linkerName, AOL defaultAOL) Called to unpack a nar file

Method Detail

getNoArchDirectory

File getNoArchDirectory(File baseDir,
                        String artifactId,
                        String version)
                        throws org.apache.maven.plugin.MojoExecutionException,
                               org.apache.maven.plugin.MojoFailureException

Specifies where all the "no architecture" specific files are stored

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getLibDirectory

File getLibDirectory(File baseDir,
                     String artifactId,
                     String version,
                     String aol,
                     String type)
                     throws org.apache.maven.plugin.MojoExecutionException,
                            org.apache.maven.plugin.MojoFailureException

Specifies where libraries are stored

Returns:

Throws:

MojoExecutionException, - MojoFailureException

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getIncludeDirectory

File getIncludeDirectory(File baseDir,
                         String artifactId,
                         String version)
                         throws org.apache.maven.plugin.MojoExecutionException,
                                org.apache.maven.plugin.MojoFailureException

Specifies where includes are stored

Returns:

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getBinDirectory

File getBinDirectory(File baseDir,
                     String artifactId,
                     String version,
                     String aol)
                     throws org.apache.maven.plugin.MojoExecutionException,
                            org.apache.maven.plugin.MojoFailureException

Specifies where binaries are stored

Returns:

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

prepareNarInfo

void prepareNarInfo(File baseDir,
                    org.apache.maven.project.MavenProject project,
                    NarInfo narInfo,
                    AbstractNarMojo libraryName)
                    throws org.apache.maven.plugin.MojoExecutionException

Called to attach nars to main nar/jar file. This method needs to set NarInfo accordingly so it can be included in the nar archive.

Throws:

org.apache.maven.plugin.MojoExecutionException

attachNars

void attachNars(File baseDir,
                org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager,
                org.apache.maven.project.MavenProjectHelper projectHelper,
                org.apache.maven.project.MavenProject project)
                throws org.apache.maven.plugin.MojoExecutionException,
                       org.apache.maven.plugin.MojoFailureException

Called to attach nars to main nar/jar file. This method needs to produce all the attached nar archive files.

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

unpackNar

void unpackNar(File baseDir,
               org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager,
               File file,
               String os,
               String linkerName,
               AOL defaultAOL)
               throws org.apache.maven.plugin.MojoExecutionException,
                      org.apache.maven.plugin.MojoFailureException

Called to unpack a nar file

Parameters:

defaultAOL -

linkerName -

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getNarUnpackDirectory

File getNarUnpackDirectory(File baseUnpackDirectory,
                           File narFile)

Returns the unpack directory of a specific nar file.