| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_172) on Fri Nov 02 16:44:10 UTC 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CreateNetBeansFileStructure (Apache NetBeans Maven Utilities - NBM Maven Plugin 4.2-SNAPSHOT API)</title> |
| <meta name="date" content="2018-11-02"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CreateNetBeansFileStructure (Apache NetBeans Maven Utilities - NBM Maven Plugin 4.2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CreateNetBeansFileStructure.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../org/netbeans/nbm/CreateNbmMojo.html" title="class in org.netbeans.nbm"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/netbeans/nbm/CreateStandaloneMojo.html" title="class in org.netbeans.nbm"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/netbeans/nbm/CreateNetBeansFileStructure.html" target="_top">Frames</a></li> |
| <li><a href="CreateNetBeansFileStructure.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.netbeans.nbm.AbstractNbmMojo">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.netbeans.nbm</div> |
| <h2 title="Class CreateNetBeansFileStructure" class="title">Class CreateNetBeansFileStructure</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.maven.plugin.AbstractMojo</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.netbeans.nbm.utils.AbstractNetbeansMojo</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../org/netbeans/nbm/AbstractNbmMojo.html" title="class in org.netbeans.nbm">org.netbeans.nbm.AbstractNbmMojo</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.netbeans.nbm.CreateNetBeansFileStructure</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../org/netbeans/nbm/CreateNbmMojo.html" title="class in org.netbeans.nbm">CreateNbmMojo</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">CreateNetBeansFileStructure</span> |
| extends <a href="../../../org/netbeans/nbm/AbstractNbmMojo.html" title="class in org.netbeans.nbm">AbstractNbmMojo</a></pre> |
| <div class="block">Create the NetBeans module directory structure, a prerequisite for nbm creation and cluster creation.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="mailto:mkleint@codehaus.org">Milos Kleint</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.netbeans.nbm.AbstractNbmMojo"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.netbeans.nbm.<a href="../../../org/netbeans/nbm/AbstractNbmMojo.html" title="class in org.netbeans.nbm">AbstractNbmMojo</a></h3> |
| <code><a href="../../../org/netbeans/nbm/AbstractNbmMojo.ArtifactResult.html" title="class in org.netbeans.nbm">AbstractNbmMojo.ArtifactResult</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.apache.tools.ant.Project</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#antProject">antProject</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#buildDir">buildDir</a></span></code> |
| <div class="block">Build directory</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#cluster">cluster</a></span></code> |
| <div class="block">NetBeans module's cluster.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#clusterDir">clusterDir</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#descriptor">descriptor</a></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">all content from the module descriptor can be defined as plugin configuration now, will be removed in 4.0 entirely</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#encoding">encoding</a></span></code> |
| <div class="block">The character encoding scheme to be applied when filtering nbm resources.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#finalName">finalName</a></span></code> |
| <div class="block">Name of the jar packaged by the jar:jar plugin</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.maven.shared.filtering.MavenResourcesFiltering</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#mavenResourcesFiltering">mavenResourcesFiltering</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../org/netbeans/nbm/model/NetBeansModule.html" title="class in org.netbeans.nbm.model">NetBeansModule</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#module">module</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#moduleJarName">moduleJarName</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#moduleType">moduleType</a></span></code> |
| <div class="block">Deployment type of the module, allowed values are <code>normal</code>,<code>eager</code>,<code>autoload</code>, |
| <code>disabled</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#nbmBuildDir">nbmBuildDir</a></span></code> |
| <div class="block">NetBeans module assembly build directory.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#nbmJavahelpSource">nbmJavahelpSource</a></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Obsolete as of NetBeans 7.0 with @HelpSetRegistration.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.maven.model.Resource[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#nbmResources">nbmResources</a></span></code> |
| <div class="block">A list of additional resources to include in the NBM file.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.apache.maven.project.MavenProject</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#project">project</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.maven.execution.MavenSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#session">session</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.maven.plugin.Mojo"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.maven.plugin.Mojo</h3> |
| <code>ROLE</code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#CreateNetBeansFileStructure--">CreateNetBeansFileStructure</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/netbeans/nbm/CreateNetBeansFileStructure.html#execute--">execute</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.netbeans.nbm.AbstractNbmMojo"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.netbeans.nbm.<a href="../../../org/netbeans/nbm/AbstractNbmMojo.html" title="class in org.netbeans.nbm">AbstractNbmMojo</a></h3> |
| <code><a href="../../../org/netbeans/nbm/AbstractNbmMojo.html#createDefaultDescriptor-org.apache.maven.project.MavenProject-boolean-">createDefaultDescriptor</a>, <a href="../../../org/netbeans/nbm/AbstractNbmMojo.html#createDependencyTree-org.apache.maven.project.MavenProject-org.apache.maven.shared.dependency.graph.DependencyGraphBuilder-java.lang.String-">createDependencyTree</a>, <a href="../../../org/netbeans/nbm/AbstractNbmMojo.html#readModuleDescriptor-java.io.File-">readModuleDescriptor</a>, <a href="../../../org/netbeans/nbm/AbstractNbmMojo.html#turnJarToNbmFile-org.apache.maven.artifact.Artifact-org.apache.maven.artifact.factory.ArtifactFactory-org.apache.maven.artifact.resolver.ArtifactResolver-org.apache.maven.project.MavenProject-org.apache.maven.artifact.repository.ArtifactRepository-">turnJarToNbmFile</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.netbeans.nbm.utils.AbstractNetbeansMojo"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.netbeans.nbm.utils.AbstractNetbeansMojo</h3> |
| <code>antProject, registerNbmAntTasks</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3> |
| <code>getLog, getPluginContext, setLog, setPluginContext</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="nbmBuildDir"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nbmBuildDir</h4> |
| <pre>@Parameter(defaultValue="${project.build.directory}/nbm", |
| property="maven.nbm.buildDir") |
| protected <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> nbmBuildDir</pre> |
| <div class="block">NetBeans module assembly build directory. |
| directory where the the NetBeans jar and nbm file get constructed.</div> |
| </li> |
| </ul> |
| <a name="buildDir"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildDir</h4> |
| <pre>@Parameter(required=true, |
| readonly=true, |
| property="project.build.directory") |
| protected <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> buildDir</pre> |
| <div class="block">Build directory</div> |
| </li> |
| </ul> |
| <a name="finalName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>finalName</h4> |
| <pre>@Parameter(alias="jarname", |
| property="project.build.finalName") |
| protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> finalName</pre> |
| <div class="block">Name of the jar packaged by the jar:jar plugin</div> |
| </li> |
| </ul> |
| <a name="descriptor"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>descriptor</h4> |
| <pre>@Parameter(defaultValue="${basedir}/src/main/nbm/module.xml") |
| protected <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> descriptor</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">all content from the module descriptor can be defined as plugin configuration now, will be removed in 4.0 entirely</span></div> |
| <div class="block">a NetBeans module descriptor containing dependency information and more..</div> |
| </li> |
| </ul> |
| <a name="cluster"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cluster</h4> |
| <pre>@Parameter(required=true, |
| defaultValue="extra") |
| protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> cluster</pre> |
| <div class="block">NetBeans module's cluster. Replaces the cluster element in module descriptor.</div> |
| </li> |
| </ul> |
| <a name="nbmJavahelpSource"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nbmJavahelpSource</h4> |
| <pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| @Parameter(defaultValue="${basedir}/src/main/javahelp") |
| protected <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> nbmJavahelpSource</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Obsolete as of NetBeans 7.0 with @HelpSetRegistration.</span></div> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="project"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>project</h4> |
| <pre>@Parameter(required=true, |
| readonly=true, |
| property="project") |
| protected org.apache.maven.project.MavenProject project</pre> |
| </li> |
| </ul> |
| <a name="nbmResources"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nbmResources</h4> |
| <pre>@Parameter |
| protected org.apache.maven.model.Resource[] nbmResources</pre> |
| <div class="block">A list of additional resources to include in the NBM file. |
| (Not in the module JAR; see <code>InstalledFileLocator</code> for retrieval.) |
| Supersedes similarly-named configuration in the module descriptor file. |
| <p>For example, to include native libraries:</p> |
| |
| <pre> |
| <nbmResource> |
| <directory>src/main/libs</directory> |
| <targetPath>modules/lib</targetPath> |
| <includes> |
| <include>*.dll</include> |
| <include>*.so</include> |
| </includes> |
| </nbmResource> |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encoding"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encoding</h4> |
| <pre>@Parameter(property="encoding", |
| defaultValue="${project.build.sourceEncoding}") |
| protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding</pre> |
| <div class="block">The character encoding scheme to be applied when filtering nbm resources.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="moduleType"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>moduleType</h4> |
| <pre>@Parameter(defaultValue="normal") |
| protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> moduleType</pre> |
| <div class="block">Deployment type of the module, allowed values are <code>normal</code>,<code>eager</code>,<code>autoload</code>, |
| <code>disabled</code>. |
| <p> |
| <code>autoload</code> - Such a module is |
| automatically enabled when some other module requires it and |
| automatically disabled otherwise.</p> |
| <p><code>eager</code> - This module type gets |
| automatically enabled when all it's dependencies are |
| satisfied. Disabled otherwise.</p> |
| <p><code>normal</code> - This is the default |
| value. This kind of module is enabled/disabled manually by |
| the user. It installs enabled.</p> |
| <p><code>disabled</code> - This kind of module is enabled/disabled manually by |
| the user. It installs disabled. Since 3.11</p> |
| |
| For details, see <a href="http://bits.netbeans.org/dev/javadoc/org-openide-modules/org/openide/modules/doc-files/api.html#enablement">Netbeans Module system docs</a> |
| |
| 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 <a href="http://jira.codehaus.org/browse/MNBMODULE-194">MNBMODULE-194</a></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.8</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="mavenResourcesFiltering"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mavenResourcesFiltering</h4> |
| <pre>@Component |
| protected org.apache.maven.shared.filtering.MavenResourcesFiltering mavenResourcesFiltering</pre> |
| </li> |
| </ul> |
| <a name="session"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>session</h4> |
| <pre>@Parameter(property="session", |
| readonly=true, |
| required=true) |
| protected org.apache.maven.execution.MavenSession session</pre> |
| </li> |
| </ul> |
| <a name="antProject"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>antProject</h4> |
| <pre>protected org.apache.tools.ant.Project antProject</pre> |
| </li> |
| </ul> |
| <a name="module"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>module</h4> |
| <pre>protected <a href="../../../org/netbeans/nbm/model/NetBeansModule.html" title="class in org.netbeans.nbm.model">NetBeansModule</a> module</pre> |
| </li> |
| </ul> |
| <a name="clusterDir"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clusterDir</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> clusterDir</pre> |
| </li> |
| </ul> |
| <a name="moduleJarName"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>moduleJarName</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> moduleJarName</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="CreateNetBeansFileStructure--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CreateNetBeansFileStructure</h4> |
| <pre>public CreateNetBeansFileStructure()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="execute--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public void execute() |
| throws org.apache.maven.plugin.MojoExecutionException, |
| org.apache.maven.plugin.MojoFailureException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> |
| <dd><code>org.apache.maven.plugin.MojoFailureException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CreateNetBeansFileStructure.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../org/netbeans/nbm/CreateNbmMojo.html" title="class in org.netbeans.nbm"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/netbeans/nbm/CreateStandaloneMojo.html" title="class in org.netbeans.nbm"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/netbeans/nbm/CreateNetBeansFileStructure.html" target="_top">Frames</a></li> |
| <li><a href="CreateNetBeansFileStructure.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.netbeans.nbm.AbstractNbmMojo">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2005–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |