blob: 17a52330f095aa7005c7853512c410aeb496e4bf [file] [log] [blame]
<!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>Serialized Form (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="Serialized Form (Apache NetBeans Maven Utilities - NBM Maven Plugin 4.2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</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>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?serialized-form.html" target="_top">Frames</a></li>
<li><a href="serialized-form.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Serialized Form" class="title">Serialized Form</h1>
</div>
<div class="serializedFormContainer">
<ul class="blockList">
<li class="blockList">
<h2 title="Package">Package&nbsp;org.netbeans.nbm.model</h2>
<ul class="blockList">
<li class="blockList"><a name="org.netbeans.nbm.model.Dependency">
<!-- -->
</a>
<h3>Class <a href="org/netbeans/nbm/model/Dependency.html" title="class in org.netbeans.nbm.model">org.netbeans.nbm.model.Dependency</a> extends <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> implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>id</h4>
<pre><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> id</pre>
<div class="block">groupId:artifactId of the dependency defined in the POM (or
a transitive dependency).</div>
</li>
<li class="blockList">
<h4>type</h4>
<pre><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> type</pre>
<div class="block">Type of module dependency. 3
possible values allowed.
<p><b>spec</b> - specification
dependency, module can only use public APIs in public
packages. Works with the version defined and any later
version.</p>
<p><b>impl</b> - implementation
dependency, module can use any class in the dependency
module, but works with just the one version of the
module.</p>
<p><b>loose</b> - similar to spec,
but isa very loose connection, no version is required, just
the module presence.</p></div>
</li>
<li class="blockListLast">
<h4>explicitValue</h4>
<pre><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> explicitValue</pre>
<div class="block">The plugin tries to resolve the
correct module name and module specification/implementation
version by examining the
dependency jar's manifest.
You can override this behaviour by
explicitly defining the value here. For example
org.openide.io/1 &gt; 10.1 for a "spec" type of dependency.</div>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="org.netbeans.nbm.model.NbmResource">
<!-- -->
</a>
<h3>Class <a href="org/netbeans/nbm/model/NbmResource.html" title="class in org.netbeans.nbm.model">org.netbeans.nbm.model.NbmResource</a> extends <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> implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>baseDirectory</h4>
<pre><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> baseDirectory</pre>
<div class="block">The base directory, all paths within the nbm file will be
the same as paths within the base directory.</div>
</li>
<li class="blockList">
<h4>relativeClusterPath</h4>
<pre><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> relativeClusterPath</pre>
<div class="block">A relative path to be added to cluster root where the files
will be copied to.</div>
</li>
<li class="blockList">
<h4>includes</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">E</a>&gt; includes</pre>
<div class="block">Field includes.</div>
</li>
<li class="blockListLast">
<h4>excludes</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">E</a>&gt; excludes</pre>
<div class="block">Field excludes.</div>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="org.netbeans.nbm.model.NetBeansModule">
<!-- -->
</a>
<h3>Class <a href="org/netbeans/nbm/model/NetBeansModule.html" title="class in org.netbeans.nbm.model">org.netbeans.nbm.model.NetBeansModule</a> extends <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> implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>moduleType</h4>
<pre><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"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block"><p>DEPRECATED, use the plugin
configuration instead. Type of the module. Possible values
are </p>
<p><b>autoload</b> - Such a module is
automatically enabled when some other module requires it and
automatically disabled otherwise.</p>
<p><b>eager</b> - This module type gets
automatically enabled when all it's dependencies are
satisfied. Disabled otherwise.</p>
<p><b>normal</b> - This is the default
value. This kind of module is enabled/disabled manually by
the user. It installs enabled.</p></div>
</li>
<li class="blockList">
<h4>codeNameBase</h4>
<pre><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> codeNameBase</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">DEPRECATED, use the plugin configuration instead.
Codenamebase of the module. Primary identification of the
module. Usually the package name. Eg.
"org.codehaus.mevenide.project".
If not defined here, the default value
is constructed from groupId and artifactId.</div>
</li>
<li class="blockList">
<h4>cluster</h4>
<pre><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"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">DEPRECATED, use the plugin configuration instead. Each
modules should belong to a cluster. A cluster is a group of
related modules. For individual modules it's not that
important. Refer to netbeans.org documentation for more
details.</div>
</li>
<li class="blockList">
<h4>requiresRestart</h4>
<pre>boolean requiresRestart</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">DEPRECATED, use the plugin configuration instead. Determines
if the module requires restart of the IDE/platform upon
installation.</div>
</li>
<li class="blockList">
<h4>manifest</h4>
<pre><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> manifest</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">DEPRECATED, use the plugin configuration instead. Location
of the manifest file with NetBeans specific manifest
entries.</div>
</li>
<li class="blockList">
<h4>homepageUrl</h4>
<pre><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> homepageUrl</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">DEPRECATED, use the plugin configuration instead. Homepage
URL of the module. Is accessible from NetBeans UI upon
installation, should point to place with additional
information about the functionality. If not defined, it
defaults to POM's url element.</div>
</li>
<li class="blockList">
<h4>distributionUrl</h4>
<pre><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> distributionUrl</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">DEPRECATED, use the plugin configuration instead. Http URL
of the location where the module can be downloaded from the
internet. This value put into the NBM and used when
generating the Autoupdate Site. Should point directly to the
NBM download.</div>
</li>
<li class="blockList">
<h4>author</h4>
<pre><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> author</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">DEPRECATED, use the plugin configuration instead. Author of
the module. Is used when generating the NBM file.</div>
</li>
<li class="blockList">
<h4>licenseName</h4>
<pre><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> licenseName</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">DEPRECATED, use the plugin configuration instead. Name of
the license. If the user already agreed to the same license
before, he/she won't be asked again to agree.</div>
</li>
<li class="blockList">
<h4>licenseFile</h4>
<pre><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> licenseFile</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">DEPRECATED, use the plugin configuration instead. Path to
the license agreement file.</div>
</li>
<li class="blockList">
<h4>libraries</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">E</a>&gt; libraries</pre>
<div class="block">Field libraries.</div>
</li>
<li class="blockList">
<h4>dependencies</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">E</a>&gt; dependencies</pre>
<div class="block">Field dependencies.</div>
</li>
<li class="blockList">
<h4>nbmResources</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">E</a>&gt; nbmResources</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Field nbmResources.</div>
</li>
<li class="blockListLast">
<h4>modelEncoding</h4>
<pre><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> modelEncoding</pre>
<div class="block">Field modelEncoding.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= 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>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?serialized-form.html" target="_top">Frames</a></li>
<li><a href="serialized-form.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2005&#x2013;2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>