nbm:directory

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

Mojo Attributes :

  • Requires a Maven 2.0 project to execute.
  • Requires dependency resolution of artifacts in scope: runtime
  • Automatically executes within the lifecycle phase: package

Optional Parameters

Name Type Description
descriptor File a netbeans module descriptor containing dependency information and more.. Default value is ${basedir}/src/main/nbm/module.xml.
distributionUrl String custom distribution URL, overriding the value in the nbm descriptor
finalName String Name of the jar packaged by the jar:jar plugin
nbmBuildDir String Netbeans module assembly build directory. directory where the the netbeans jar and nbm file get constructed. Default value is ${project.build.directory}/nbm.
nbmJavahelpSource File 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", the the actual docs files shall go to ${basedir}/src/main/javahelp/org/netbeans/modules/apisupport/docs
Additionally if you provide docs, you will need to place the JavaHelp jar on the classpath of the nbm-plugin for the project. The jar is to be found in the netbeans/harness directory of any NetBeans installation.
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>nbm-maven-plugin</artifactId>
<extensions>true</extensions>
<dependencies>
<dependency>
<groupId>javax.help</groupId>
<artifactId>search</artifactId>
<version>2.0</version>
<!--scope>system</scope>
<systemPath>/home/mkleint/netbeans/harness/jsearch-2.0_04.jar</systemPath-->
</dependency>
</dependencies>
</plugin>

 Default value is ${basedir}/src/main/javahelp.

Parameter Details

descriptor

a netbeans module descriptor containing dependency information and more..

  • Type : java.io.File
  • Required : No
  • Default : ${basedir}/src/main/nbm/module.xml

distributionUrl

custom distribution URL, overriding the value in the nbm descriptor

  • Type : java.lang.String
  • Required : No
  • Expression : ${maven.nbm.distributionURL}

finalName

Name of the jar packaged by the jar:jar plugin

  • Type : java.lang.String
  • Required : No
  • Expression : ${project.build.finalName}

nbmBuildDir

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

  • Type : java.lang.String
  • Required : No
  • Expression : ${maven.nbm.buildDir}
  • Default : ${project.build.directory}/nbm

nbmJavahelpSource

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", the the actual docs files shall go to ${basedir}/src/main/javahelp/org/netbeans/modules/apisupport/docs
Additionally if you provide docs, you will need to place the JavaHelp jar on the classpath of the nbm-plugin for the project. The jar is to be found in the netbeans/harness directory of any NetBeans installation.
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>nbm-maven-plugin</artifactId>
<extensions>true</extensions>
<dependencies>
<dependency>
<groupId>javax.help</groupId>
<artifactId>search</artifactId>
<version>2.0</version>
<!--scope>system</scope>
<systemPath>/home/mkleint/netbeans/harness/jsearch-2.0_04.jar</systemPath-->
</dependency>
</dependencies>
</plugin>

  • Type : java.io.File
  • Since : 2.7
  • Required : No
  • Default : ${basedir}/src/main/javahelp