org.codehaus.mojo.nbm

Class CreateNetBeansFileStructure

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.nbm.utils.AbstractNetbeansMojo

org.codehaus.mojo.nbm.AbstractNbmMojo

org.codehaus.mojo.nbm.CreateNetBeansFileStructure

All Implemented Interfaces:

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

Direct Known Subclasses:

CreateNbmMojo

public abstract class CreateNetBeansFileStructure
extends AbstractNbmMojo

Create the NetBeans module directory structure, a prerequisite for nbm creation and cluster creation.

Author:

Milos Kleint

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.mojo.nbm.AbstractNbmMojo

AbstractNbmMojo.ArtifactResult

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.tools.ant.Project	antProject
protected File	buildDir Build directory
protected String	cluster NetBeans module's cluster.
protected File	clusterDir
protected File	descriptor Deprecated. all content from the module descriptor can be defined as plugin configuration now, will be removed in 4.0 entirely
protected String	encoding The character encoding scheme to be applied when filtering nbm resources.
protected String	finalName Name of the jar packaged by the jar:jar plugin
protected org.apache.maven.shared.filtering.MavenResourcesFiltering	mavenResourcesFiltering
protected NetBeansModule	module
protected String	moduleJarName
protected String	moduleType Deployment type of the module, allowed values are normal,eager,autoload, disabled.
protected File	nbmBuildDir NetBeans module assembly build directory.
protected File	nbmJavahelpSource Deprecated. Obsolete as of NetBeans 7.0 with @HelpSetRegistration.
protected org.apache.maven.model.Resource[]	nbmResources A list of additional resources to include in the NBM file.
protected org.apache.maven.project.MavenProject	project
protected org.apache.maven.execution.MavenSession	session

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

ROLE

Constructor Summary

Constructors

Constructor and Description
CreateNetBeansFileStructure()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()

Methods inherited from class org.codehaus.mojo.nbm.AbstractNbmMojo

createDefaultDescriptor, createDependencyTree, readModuleDescriptor, turnJarToNbmFile

Methods inherited from class org.codehaus.mojo.nbm.utils.AbstractNetbeansMojo

antProject, registerNbmAntTasks

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

nbmBuildDir

@Parameter(defaultValue="${project.build.directory}/nbm",
           property="maven.nbm.buildDir")
protected File nbmBuildDir

NetBeans module assembly build directory. directory where the the NetBeans jar and nbm file get constructed.

buildDir

@Parameter(required=true,
           readonly=true,
           property="project.build.directory")
protected File buildDir

Build directory

finalName

@Parameter(alias="jarname",
           property="project.build.finalName")
protected String finalName

Name of the jar packaged by the jar:jar plugin

descriptor

@Parameter(defaultValue="${basedir}/src/main/nbm/module.xml")
protected File descriptor

Deprecated. all content from the module descriptor can be defined as plugin configuration now, will be removed in 4.0 entirely

a NetBeans module descriptor containing dependency information and more..

cluster

@Parameter(required=true,
           defaultValue="extra")
protected String cluster

NetBeans module's cluster. Replaces the cluster element in module descriptor.

nbmJavahelpSource

@Deprecated
@Parameter(defaultValue="${basedir}/src/main/javahelp")
protected File nbmJavahelpSource

Deprecated. Obsolete as of NetBeans 7.0 with @HelpSetRegistration.

The location of JavaHelp sources for the project. The documentation itself is expected to be in the directory structure based on codenamebase of the module. eg. if your codenamebase is "org.netbeans.modules.apisupport", then the actual docs files shall go to ${basedir}/src/main/javahelp/org/netbeans/modules/apisupport/docs.

Since:

2.7

project

@Parameter(required=true,
           readonly=true,
           property="project")
protected org.apache.maven.project.MavenProject project

nbmResources

@Parameter
protected org.apache.maven.model.Resource[] nbmResources

A list of additional resources to include in the NBM file. (Not in the module JAR; see InstalledFileLocator for retrieval.) Supersedes similarly-named configuration in the module descriptor file.

For example, to include native libraries:

            <nbmResource>
              <directory>src/main/libs</directory>
              <targetPath>modules/lib</targetPath>
              <includes>
                <include>*.dll</include>
                <include>*.so</include>
              </includes>
            </nbmResource>
     

Since:

3.2

encoding

@Parameter(property="encoding",
           defaultValue="${project.build.sourceEncoding}")
protected String encoding

The character encoding scheme to be applied when filtering nbm resources.

Since:

3.2

moduleType

@Parameter(defaultValue="normal")
protected String moduleType

Deployment type of the module, allowed values are normal,eager,autoload, disabled.

autoload - Such a module is automatically enabled when some other module requires it and automatically disabled otherwise.

eager - This module type gets automatically enabled when all it's dependencies are satisfied. Disabled otherwise.

normal - This is the default value. This kind of module is enabled/disabled manually by the user. It installs enabled.

disabled - This kind of module is enabled/disabled manually by the user. It installs disabled. Since 3.11

For details, see Netbeans Module system docs Since 3.14, for autoload and eager modules, we automatically set AutoUpdate-Show-In-Client manifest entry to false, if not defined already otherwise in the manifest. See issue MNBMODULE-194

Since:

3.8

mavenResourcesFiltering

@Component
protected org.apache.maven.shared.filtering.MavenResourcesFiltering mavenResourcesFiltering

session

@Parameter(property="session",
           readonly=true,
           required=true)
protected org.apache.maven.execution.MavenSession session

antProject

protected org.apache.tools.ant.Project antProject

module

protected NetBeansModule module

clusterDir

protected File clusterDir

moduleJarName

protected String moduleJarName

Constructor Detail

CreateNetBeansFileStructure

public CreateNetBeansFileStructure()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException