| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.11.1 at 2023-07-10 |
| | Rendered using Apache Maven Fluido Skin 1.6 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="Date-Revision-yyyymmdd" content="20230710" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Apache Sling OSGi Feature Maven Plugin – slingfeature:apis-jar</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script type="text/javascript" src="./js/apache-maven-fluido-1.6.min.js"></script> |
| </head> |
| <body class="topBarDisabled"> |
| <a href="https://github.com/apache/sling-dummyproject"> |
| <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;" |
| src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" |
| alt="Fork me on GitHub"> |
| </a> |
| <div class="container-fluid"> |
| <div id="banner"> |
| <div class="pull-left"><a href="https://sling.apache.org/" id="bannerLeft"><img src="https://sling.apache.org/res/logos/sling.svg" alt="Apache Sling" width="123px" height="63px"/></a></div> |
| <div class="pull-right"><a href="https://apache.org/" id="bannerRight"><img src="https://sling.apache.org/res/logos/apache.png" alt="Apache"/></a></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li class=""><a href="https://sling.apache.org/" class="externalLink" title="Apache Sling">Apache Sling</a><span class="divider">/</span></li> |
| <li class=""><a href="https://sling.apache.org/components/" class="externalLink" title="Maven Plugins">Maven Plugins</a><span class="divider">/</span></li> |
| <li class=""><a href="index.html" title="Apache Sling OSGi Feature Maven Plugin">Apache Sling OSGi Feature Maven Plugin</a><span class="divider">/</span></li> |
| <li class="active ">slingfeature:apis-jar</li> |
| <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-07-10</li> |
| <li id="projectVersion" class="pull-right">Version: 1.7.2</li> |
| </ul> |
| </div> |
| <div class="row-fluid"> |
| <div id="leftColumn" class="span2"> |
| <div class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Overview</li> |
| <li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a> </li> |
| <li><a href="plugin-info.html" title="Goals"><span class="none"></span>Goals</a> </li> |
| <li class="nav-header">Project Documentation</li> |
| <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a> </li> |
| <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a> </li> |
| </ul> |
| <hr /> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </div> |
| <div id="bodyColumn" class="span10" > |
| |
| |
| <section> |
| <h2><a name="slingfeature:apis-jar"></a>slingfeature:apis-jar</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.apache.sling:slingfeature-maven-plugin:1.7.2:apis-jar</p> |
| |
| <p><b>Description</b>:</p> |
| |
| <div>Generates the APIs JARs for the selected feature files.</div> |
| |
| <p><b>Attributes</b>:</p> |
| |
| <ul> |
| |
| <li>Requires a Maven project to be executed.</li> |
| |
| <li>Requires dependency resolution of artifacts in scope: <code>test</code>.</li> |
| |
| <li>The goal is thread-safe and supports parallel builds.</li> |
| |
| <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <code>package</code>.</li> |
| </ul> |
| <section> |
| <h3><a name="Required_Parameters"></a>Required Parameters</h3> |
| |
| <table class="table table-striped" border="0"> |
| |
| <tr class="a"> |
| |
| <th>Name</th> |
| |
| <th>Type</th> |
| |
| <th>Since</th> |
| |
| <th>Description</th> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#features"><features></a></code></td> |
| |
| <td><code>File</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Directory containing feature files<br /><b>Default value is</b>: <code>src/main/features</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#testFeatures"><testFeatures></a></code></td> |
| |
| <td><code>File</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Directory containing test feature files.<br /><b>Default value is</b>: <code>src/test/features</code>.<br /></td> |
| </tr> |
| </table> |
| </section> |
| <section> |
| <h3><a name="Optional_Parameters"></a>Optional Parameters</h3> |
| |
| <table class="table table-striped" border="0"> |
| |
| <tr class="a"> |
| |
| <th>Name</th> |
| |
| <th>Type</th> |
| |
| <th>Since</th> |
| |
| <th>Description</th> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#apiClassifierMappings"><apiClassifierMappings></a></code></td> |
| |
| <td><code>Map</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Mapping for the feature classifier to a user defined name<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#apiJavadocResources"><apiJavadocResources></a></code></td> |
| |
| <td><code>List</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Additional resources for the api javadoc jar<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#apiName"><apiName></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>1.5.6</code></td> |
| |
| <td>Optional artifact name which is used instead of the generated |
| artifact name to set some headers in the manifest.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#apiRegionNameMappings"><apiRegionNameMappings></a></code></td> |
| |
| <td><code>Map</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Mapping for an api region name to a user defined name<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#apiRepositoryUrls"><apiRepositoryUrls></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>1.3.0</code></td> |
| |
| <td>Comma separated list of Maven repository lists. If set, and |
| <code>useApiDependencies</code> is enabled, then one of the listed |
| repositories must provide the artifact. If it is not set, all |
| artifacts are used as dependencies if |
| <code>useApiDependencies</code> is enabled.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#apiResources"><apiResources></a></code></td> |
| |
| <td><code>List</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Additional resources for the api jar<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#apiSourceResources"><apiSourceResources></a></code></td> |
| |
| <td><code>List</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Additional resources for the api source jar<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#apiVersion"><apiVersion></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>1.2.0</code></td> |
| |
| <td>Optional version to be put into the manifest of the created jars<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#attachApiJars"><attachApiJars></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>If enabled, the created api jars will be attached to the project<br /><b>Default value is</b>: <code>true</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#enableLegacyVariableReplacement"><enableLegacyVariableReplacement></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>1.3.6</code></td> |
| |
| <td>Enable old variable replacement in feature model based on the full |
| maven project including system variables. If this is enabled, |
| enableProjectVariableReplacement and replacePropertyVariables have |
| no effect.<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#enableProjectVariableReplacement"><enableProjectVariableReplacement></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>1.3.6</code></td> |
| |
| <td>Enable the replacement of variables when reading a feature model. |
| The supported variables are "project.groupId", |
| "project.artifactId", "project.version" and "project.osgiVersion".<br /><b>Default value is</b>: <code>true</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#enabledToggles"><enabledToggles></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>1.5.0</code></td> |
| |
| <td>A comma separated list of enabled toggles used as input to generate |
| the api jars.<br /><b>User property is</b>: <code>enabled.toggles</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#excludeRegions"><excludeRegions></a></code></td> |
| |
| <td><code>Set</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Names of the regions to exclude, by default no regions is excluded.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#failOnError"><failOnError></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>1.3.2</code></td> |
| |
| <td>Fail the build if errors are detected. For example, errors could be |
| missing packages in the api jars, or too many packages in those |
| jars.<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#failOnMissingSourcesForJavadoc"><failOnMissingSourcesForJavadoc></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>1.3.6</code></td> |
| |
| <td>Fail the build if sources are mising for javadoc generation<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#featuresExcludes"><featuresExcludes></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Comma separated list of excludes for the feature files. Feature |
| files excluded by this configuration are not processed at all.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#featuresIncludes"><featuresIncludes></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Comma separated list of includes for the feature files in the |
| configured directory. Only feature files specified by this include |
| are processed.<br /><b>Default value is</b>: <code>**/*.json</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#generateApiJar"><generateApiJar></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Generate api jar<br /><b>Default value is</b>: <code>true</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#generateJavadocForAllApi"><generateJavadocForAllApi></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>1.5.2</code></td> |
| |
| <td>If <code>useApiDependencies</code> is set to <code>true</code> and |
| <code>useApiDependenciesForJavadoc</code> is set to |
| <code>true</code> this can be set to <code>false</code> to generate |
| an additional javadoc API jar with all javadoc including the API |
| from dependencies.<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#generateJavadocJar"><generateJavadocJar></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Generate the javadoc jar<br /><b>Default value is</b>: <code>true</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#generateSourceJar"><generateSourceJar></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Generate the sources jar<br /><b>Default value is</b>: <code>true</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#generatedFeatures"><generatedFeatures></a></code></td> |
| |
| <td><code>File</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Directory containing generated feature files<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#generatedFeaturesExcludes"><generatedFeaturesExcludes></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Comma separated list of excludes for the generated feature files. |
| Feature files excluded by this configuration are not processed at |
| all.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#generatedFeaturesIncludes"><generatedFeaturesIncludes></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Comma separated list of includes for the generated feature files in |
| the configured directory. Only feature files specified by this |
| include are processed.<br /><b>Default value is</b>: <code>**/*.json</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#ignoreJavadocErrors"><ignoreJavadocErrors></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Ignore errors in javadoc generation<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#includeRegions"><includeRegions></a></code></td> |
| |
| <td><code>Set</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Names of the regions to include, by default all regions are |
| included.<br /><b>Default value is</b>: <code>*</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#includeResources"><includeResources></a></code></td> |
| |
| <td><code>String[]</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Patterns identifying which resources to include from bundles. This |
| can be used to include files like license or notices files. |
| Starting with version 1.2.0 these files are only searched in the |
| folders mentioned by <code>#resourceFolders</code><br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#incrementalApis"><incrementalApis></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>If set to true and api jars are created for more than one region, |
| then the higher region only gets the difference to the lower |
| region. If set to false each api jar gets the full region |
| information (duplicating information)<br /><b>Default value is</b>: <code>true</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#jarStartOrder"><jarStartOrder></a></code></td> |
| |
| <td><code>int</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>The start level for the attached jar/bundle.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#javadocAdditionalExtensions"><javadocAdditionalExtensions></a></code></td> |
| |
| <td><code>List</code></td> |
| |
| <td><code>1.5.0</code></td> |
| |
| <td>A list of configurations to add additional artifacts to a region |
| for javadoc generation. The value is a comma separated list of |
| extension names from the feature model. If such an extension |
| exists, it must be of type artifacts. The list of names can be |
| prefixed with a region name separated by a colon from the list of |
| names. In that case, the artifacts are only added to that region.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#javadocClasspathHighestVersions"><javadocClasspathHighestVersions></a></code></td> |
| |
| <td><code>List</code></td> |
| |
| <td><code>1.3.14</code></td> |
| |
| <td>A artifact patterns to match artifacts put on the javadoc |
| classpath. Follows the pattern |
| "groupId:artifactId:type:classifier:version". From the matching |
| artifacts, only the highest version is kept per artifact. This rule |
| is applied after the removals.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#javadocClasspathRemovals"><javadocClasspathRemovals></a></code></td> |
| |
| <td><code>List</code></td> |
| |
| <td><code>1.3.14</code></td> |
| |
| <td>A artifact patterns to match artifacts put on the javadoc |
| classpath. Follows the pattern |
| "groupId:artifactId:type:classifier:version". Any matching artifact |
| is removed from the classpath. Removals are processed first.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#javadocClasspathTops"><javadocClasspathTops></a></code></td> |
| |
| <td><code>List</code></td> |
| |
| <td><code>1.3.14</code></td> |
| |
| <td>A artifact patterns to match artifacts put on the javadoc |
| classpath. Follows the pattern |
| "groupId:artifactId:type:classifier:version". Any matching artifact |
| is put at the top of the classpath. This rule is applied last.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#javadocIndex"><javadocIndex></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>1.3.6</code></td> |
| |
| <td>Whether the index should be generated<br /><b>Default value is</b>: <code>true</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#javadocLinks"><javadocLinks></a></code></td> |
| |
| <td><code>String[]</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>List of javadoc links used in the javadoc generation.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#javadocSourceLevel"><javadocSourceLevel></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Source level for javadoc generation<br /><b>Default value is</b>: <code>8</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#javadocTree"><javadocTree></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>1.3.6</code></td> |
| |
| <td>Whether the tree should be generated<br /><b>Default value is</b>: <code>true</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#licenseDefaults"><licenseDefaults></a></code></td> |
| |
| <td><code>List</code></td> |
| |
| <td><code>1.2.0</code></td> |
| |
| <td>A artifact patterns to match artifacts without a license. Follows |
| the pattern "groupId:artifactId:type:classifier:version". After the |
| patter a "=" followed by the license information needs to be |
| specified. This information is used in the license report if no |
| license is specified for an artifact.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#licenseReport"><licenseReport></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>1.2.0</code></td> |
| |
| <td>Create a license report file. This is the name of that file within |
| the jar<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#licenseReportFooter"><licenseReportFooter></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>1.2.0</code></td> |
| |
| <td>Footer added at the bottom of the license report<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#licenseReportHeader"><licenseReportHeader></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>1.2.0</code></td> |
| |
| <td>Header added on top of the license report<br /><b>Default value is</b>: <code>This archive contains files from the following artifacts:</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#manifestProperties"><manifestProperties></a></code></td> |
| |
| <td><code>Properties</code></td> |
| |
| <td><code>1.3.2</code></td> |
| |
| <td>specify the manifest properties values that you need to replace in |
| the Manifest file.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#replacePropertyVariables"><replacePropertyVariables></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>1.3.6</code></td> |
| |
| <td>A comma separated list of variables which are replaced when a |
| feature model is read. The value of these variables is fetched from |
| the project properties.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#resourceFolders"><resourceFolders></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>1.2.0</code></td> |
| |
| <td>Comma separated list of folders where files are renamed.<br /><b>Default value is</b>: <code>META-INF,SLING-INF</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#selection"><selection></a></code></td> |
| |
| <td><code>FeatureSelectionConfig</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Select the features for api generation. Separate api jars will be |
| generated for each feature.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#skipAddFeatureDependencies"><skipAddFeatureDependencies></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>If set to <code>true</code> the artifacts from the feature are not |
| as dependencies to the project.<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#skipAddJarToFeature"><skipAddJarToFeature></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>If set to <code>true</code> the main jar artifact is not added to |
| the feature.<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#skipAddJarToTestFeature"><skipAddJarToTestFeature></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>If set to <code>true</code> the main jar artifact is not added to |
| the test feature.<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#skipAddTestFeatureDependencies"><skipAddTestFeatureDependencies></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>If set to <code>true</code> the artifacts from the test feature are |
| not as dependencies to the project.<br /><b>Default value is</b>: <code>true</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#testFeaturesExcludes"><testFeaturesExcludes></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Comma separated list of excludes for the test features.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#testFeaturesIncludes"><testFeaturesIncludes></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Comma separated list of includes for the test features.<br /><b>Default value is</b>: <code>**/*.json</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#toggleApiOnly"><toggleApiOnly></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>1.4.26</code></td> |
| |
| <td>If set to true the apis jar will only contain api which is behind |
| the enabled toggles. All other public api is not included. If set |
| to false (the default) all public api is included per region.<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#useApiDependencies"><useApiDependencies></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>1.3.0</code></td> |
| |
| <td>If enabled, packages from artifacts which are fully consumed (all |
| public api) are omitted from the api and source jars and a |
| dependency list is generated instead.<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#useApiDependenciesForJavadoc"><useApiDependenciesForJavadoc></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>1.5.2</code></td> |
| |
| <td>If this is set to <code>false</code> the javadoc generated will |
| always contain all APIs even the api from dependencies (if |
| <code>useApiDependencies</code>) is enabled. If this is set to |
| <code>true</code> the javadoc will not contain the API from |
| dependencies and exactly match the binary and source jars.<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#validateFeatures"><validateFeatures></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>If set to <code>true</code> the features are validated against the |
| JSON schema.<br /><b>Default value is</b>: <code>true</code>.<br /></td> |
| </tr> |
| </table> |
| </section> |
| <section> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| <section> |
| <h4><a name="a.3CapiClassifierMappings.3E"></a><b><a name="apiClassifierMappings"><apiClassifierMappings></a></b></h4> |
| |
| <div>Mapping for the feature classifier to a user defined name</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.Map</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CapiJavadocResources.3E"></a><b><a name="apiJavadocResources"><apiJavadocResources></a></b></h4> |
| |
| <div>Additional resources for the api javadoc jar</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.List</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CapiName.3E"></a><b><a name="apiName"><apiName></a></b></h4> |
| |
| <div>Optional artifact name which is used instead of the generated |
| artifact name to set some headers in the manifest.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Since</b>: <code>1.5.6</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CapiRegionNameMappings.3E"></a><b><a name="apiRegionNameMappings"><apiRegionNameMappings></a></b></h4> |
| |
| <div>Mapping for an api region name to a user defined name</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.Map</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CapiRepositoryUrls.3E"></a><b><a name="apiRepositoryUrls"><apiRepositoryUrls></a></b></h4> |
| |
| <div>Comma separated list of Maven repository lists. If set, and |
| <code>useApiDependencies</code> is enabled, then one of the listed |
| repositories must provide the artifact. If it is not set, all |
| artifacts are used as dependencies if |
| <code>useApiDependencies</code> is enabled.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Since</b>: <code>1.3.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CapiResources.3E"></a><b><a name="apiResources"><apiResources></a></b></h4> |
| |
| <div>Additional resources for the api jar</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.List</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CapiSourceResources.3E"></a><b><a name="apiSourceResources"><apiSourceResources></a></b></h4> |
| |
| <div>Additional resources for the api source jar</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.List</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CapiVersion.3E"></a><b><a name="apiVersion"><apiVersion></a></b></h4> |
| |
| <div>Optional version to be put into the manifest of the created jars</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Since</b>: <code>1.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CattachApiJars.3E"></a><b><a name="attachApiJars"><attachApiJars></a></b></h4> |
| |
| <div>If enabled, the created api jars will be attached to the project</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CenableLegacyVariableReplacement.3E"></a><b><a name="enableLegacyVariableReplacement"><enableLegacyVariableReplacement></a></b></h4> |
| |
| <div>Enable old variable replacement in feature model based on the full |
| maven project including system variables. If this is enabled, |
| enableProjectVariableReplacement and replacePropertyVariables have |
| no effect.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Since</b>: <code>1.3.6</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CenableProjectVariableReplacement.3E"></a><b><a name="enableProjectVariableReplacement"><enableProjectVariableReplacement></a></b></h4> |
| |
| <div>Enable the replacement of variables when reading a feature model. |
| The supported variables are "project.groupId", |
| "project.artifactId", "project.version" and "project.osgiVersion".</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Since</b>: <code>1.3.6</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CenabledToggles.3E"></a><b><a name="enabledToggles"><enabledToggles></a></b></h4> |
| |
| <div>A comma separated list of enabled toggles used as input to generate |
| the api jars.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Since</b>: <code>1.5.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>enabled.toggles</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CexcludeRegions.3E"></a><b><a name="excludeRegions"><excludeRegions></a></b></h4> |
| |
| <div>Names of the regions to exclude, by default no regions is excluded.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.Set</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CfailOnError.3E"></a><b><a name="failOnError"><failOnError></a></b></h4> |
| |
| <div>Fail the build if errors are detected. For example, errors could be |
| missing packages in the api jars, or too many packages in those |
| jars.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Since</b>: <code>1.3.2</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CfailOnMissingSourcesForJavadoc.3E"></a><b><a name="failOnMissingSourcesForJavadoc"><failOnMissingSourcesForJavadoc></a></b></h4> |
| |
| <div>Fail the build if sources are mising for javadoc generation</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Since</b>: <code>1.3.6</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cfeatures.3E"></a><b><a name="features"><features></a></b></h4> |
| |
| <div>Directory containing feature files</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.io.File</code></li> |
| |
| <li><b>Required</b>: <code>Yes</code></li> |
| |
| <li><b>Default</b>: <code>src/main/features</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CfeaturesExcludes.3E"></a><b><a name="featuresExcludes"><featuresExcludes></a></b></h4> |
| |
| <div>Comma separated list of excludes for the feature files. Feature |
| files excluded by this configuration are not processed at all.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CfeaturesIncludes.3E"></a><b><a name="featuresIncludes"><featuresIncludes></a></b></h4> |
| |
| <div>Comma separated list of includes for the feature files in the |
| configured directory. Only feature files specified by this include |
| are processed.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>**/*.json</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CgenerateApiJar.3E"></a><b><a name="generateApiJar"><generateApiJar></a></b></h4> |
| |
| <div>Generate api jar</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CgenerateJavadocForAllApi.3E"></a><b><a name="generateJavadocForAllApi"><generateJavadocForAllApi></a></b></h4> |
| |
| <div>If <code>useApiDependencies</code> is set to <code>true</code> and |
| <code>useApiDependenciesForJavadoc</code> is set to |
| <code>true</code> this can be set to <code>false</code> to generate |
| an additional javadoc API jar with all javadoc including the API |
| from dependencies.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Since</b>: <code>1.5.2</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CgenerateJavadocJar.3E"></a><b><a name="generateJavadocJar"><generateJavadocJar></a></b></h4> |
| |
| <div>Generate the javadoc jar</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CgenerateSourceJar.3E"></a><b><a name="generateSourceJar"><generateSourceJar></a></b></h4> |
| |
| <div>Generate the sources jar</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CgeneratedFeatures.3E"></a><b><a name="generatedFeatures"><generatedFeatures></a></b></h4> |
| |
| <div>Directory containing generated feature files</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.io.File</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CgeneratedFeaturesExcludes.3E"></a><b><a name="generatedFeaturesExcludes"><generatedFeaturesExcludes></a></b></h4> |
| |
| <div>Comma separated list of excludes for the generated feature files. |
| Feature files excluded by this configuration are not processed at |
| all.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CgeneratedFeaturesIncludes.3E"></a><b><a name="generatedFeaturesIncludes"><generatedFeaturesIncludes></a></b></h4> |
| |
| <div>Comma separated list of includes for the generated feature files in |
| the configured directory. Only feature files specified by this |
| include are processed.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>**/*.json</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CignoreJavadocErrors.3E"></a><b><a name="ignoreJavadocErrors"><ignoreJavadocErrors></a></b></h4> |
| |
| <div>Ignore errors in javadoc generation</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CincludeRegions.3E"></a><b><a name="includeRegions"><includeRegions></a></b></h4> |
| |
| <div>Names of the regions to include, by default all regions are |
| included.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.Set</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>*</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CincludeResources.3E"></a><b><a name="includeResources"><includeResources></a></b></h4> |
| |
| <div>Patterns identifying which resources to include from bundles. This |
| can be used to include files like license or notices files. |
| Starting with version 1.2.0 these files are only searched in the |
| folders mentioned by <code>#resourceFolders</code></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String[]</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CincrementalApis.3E"></a><b><a name="incrementalApis"><incrementalApis></a></b></h4> |
| |
| <div>If set to true and api jars are created for more than one region, |
| then the higher region only gets the difference to the lower |
| region. If set to false each api jar gets the full region |
| information (duplicating information)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CjarStartOrder.3E"></a><b><a name="jarStartOrder"><jarStartOrder></a></b></h4> |
| |
| <div>The start level for the attached jar/bundle.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>int</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CjavadocAdditionalExtensions.3E"></a><b><a name="javadocAdditionalExtensions"><javadocAdditionalExtensions></a></b></h4> |
| |
| <div>A list of configurations to add additional artifacts to a region |
| for javadoc generation. The value is a comma separated list of |
| extension names from the feature model. If such an extension |
| exists, it must be of type artifacts. The list of names can be |
| prefixed with a region name separated by a colon from the list of |
| names. In that case, the artifacts are only added to that region.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.List</code></li> |
| |
| <li><b>Since</b>: <code>1.5.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CjavadocClasspathHighestVersions.3E"></a><b><a name="javadocClasspathHighestVersions"><javadocClasspathHighestVersions></a></b></h4> |
| |
| <div>A artifact patterns to match artifacts put on the javadoc |
| classpath. Follows the pattern |
| "groupId:artifactId:type:classifier:version". From the matching |
| artifacts, only the highest version is kept per artifact. This rule |
| is applied after the removals.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.List</code></li> |
| |
| <li><b>Since</b>: <code>1.3.14</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CjavadocClasspathRemovals.3E"></a><b><a name="javadocClasspathRemovals"><javadocClasspathRemovals></a></b></h4> |
| |
| <div>A artifact patterns to match artifacts put on the javadoc |
| classpath. Follows the pattern |
| "groupId:artifactId:type:classifier:version". Any matching artifact |
| is removed from the classpath. Removals are processed first.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.List</code></li> |
| |
| <li><b>Since</b>: <code>1.3.14</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CjavadocClasspathTops.3E"></a><b><a name="javadocClasspathTops"><javadocClasspathTops></a></b></h4> |
| |
| <div>A artifact patterns to match artifacts put on the javadoc |
| classpath. Follows the pattern |
| "groupId:artifactId:type:classifier:version". Any matching artifact |
| is put at the top of the classpath. This rule is applied last.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.List</code></li> |
| |
| <li><b>Since</b>: <code>1.3.14</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CjavadocIndex.3E"></a><b><a name="javadocIndex"><javadocIndex></a></b></h4> |
| |
| <div>Whether the index should be generated</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Since</b>: <code>1.3.6</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CjavadocLinks.3E"></a><b><a name="javadocLinks"><javadocLinks></a></b></h4> |
| |
| <div>List of javadoc links used in the javadoc generation.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String[]</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CjavadocSourceLevel.3E"></a><b><a name="javadocSourceLevel"><javadocSourceLevel></a></b></h4> |
| |
| <div>Source level for javadoc generation</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>8</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CjavadocTree.3E"></a><b><a name="javadocTree"><javadocTree></a></b></h4> |
| |
| <div>Whether the tree should be generated</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Since</b>: <code>1.3.6</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3ClicenseDefaults.3E"></a><b><a name="licenseDefaults"><licenseDefaults></a></b></h4> |
| |
| <div>A artifact patterns to match artifacts without a license. Follows |
| the pattern "groupId:artifactId:type:classifier:version". After the |
| patter a "=" followed by the license information needs to be |
| specified. This information is used in the license report if no |
| license is specified for an artifact.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.List</code></li> |
| |
| <li><b>Since</b>: <code>1.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3ClicenseReport.3E"></a><b><a name="licenseReport"><licenseReport></a></b></h4> |
| |
| <div>Create a license report file. This is the name of that file within |
| the jar</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Since</b>: <code>1.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3ClicenseReportFooter.3E"></a><b><a name="licenseReportFooter"><licenseReportFooter></a></b></h4> |
| |
| <div>Footer added at the bottom of the license report</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Since</b>: <code>1.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3ClicenseReportHeader.3E"></a><b><a name="licenseReportHeader"><licenseReportHeader></a></b></h4> |
| |
| <div>Header added on top of the license report</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Since</b>: <code>1.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>This archive contains files from the following artifacts:</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CmanifestProperties.3E"></a><b><a name="manifestProperties"><manifestProperties></a></b></h4> |
| |
| <div>specify the manifest properties values that you need to replace in |
| the Manifest file.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.Properties</code></li> |
| |
| <li><b>Since</b>: <code>1.3.2</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CreplacePropertyVariables.3E"></a><b><a name="replacePropertyVariables"><replacePropertyVariables></a></b></h4> |
| |
| <div>A comma separated list of variables which are replaced when a |
| feature model is read. The value of these variables is fetched from |
| the project properties.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Since</b>: <code>1.3.6</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CresourceFolders.3E"></a><b><a name="resourceFolders"><resourceFolders></a></b></h4> |
| |
| <div>Comma separated list of folders where files are renamed.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Since</b>: <code>1.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>META-INF,SLING-INF</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cselection.3E"></a><b><a name="selection"><selection></a></b></h4> |
| |
| <div>Select the features for api generation. Separate api jars will be |
| generated for each feature.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>org.apache.sling.feature.maven.mojos.FeatureSelectionConfig</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CskipAddFeatureDependencies.3E"></a><b><a name="skipAddFeatureDependencies"><skipAddFeatureDependencies></a></b></h4> |
| |
| <div>If set to <code>true</code> the artifacts from the feature are not |
| as dependencies to the project.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CskipAddJarToFeature.3E"></a><b><a name="skipAddJarToFeature"><skipAddJarToFeature></a></b></h4> |
| |
| <div>If set to <code>true</code> the main jar artifact is not added to |
| the feature.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CskipAddJarToTestFeature.3E"></a><b><a name="skipAddJarToTestFeature"><skipAddJarToTestFeature></a></b></h4> |
| |
| <div>If set to <code>true</code> the main jar artifact is not added to |
| the test feature.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CskipAddTestFeatureDependencies.3E"></a><b><a name="skipAddTestFeatureDependencies"><skipAddTestFeatureDependencies></a></b></h4> |
| |
| <div>If set to <code>true</code> the artifacts from the test feature are |
| not as dependencies to the project.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CtestFeatures.3E"></a><b><a name="testFeatures"><testFeatures></a></b></h4> |
| |
| <div>Directory containing test feature files.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.io.File</code></li> |
| |
| <li><b>Required</b>: <code>Yes</code></li> |
| |
| <li><b>Default</b>: <code>src/test/features</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CtestFeaturesExcludes.3E"></a><b><a name="testFeaturesExcludes"><testFeaturesExcludes></a></b></h4> |
| |
| <div>Comma separated list of excludes for the test features.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CtestFeaturesIncludes.3E"></a><b><a name="testFeaturesIncludes"><testFeaturesIncludes></a></b></h4> |
| |
| <div>Comma separated list of includes for the test features.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>**/*.json</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CtoggleApiOnly.3E"></a><b><a name="toggleApiOnly"><toggleApiOnly></a></b></h4> |
| |
| <div>If set to true the apis jar will only contain api which is behind |
| the enabled toggles. All other public api is not included. If set |
| to false (the default) all public api is included per region.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Since</b>: <code>1.4.26</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CuseApiDependencies.3E"></a><b><a name="useApiDependencies"><useApiDependencies></a></b></h4> |
| |
| <div>If enabled, packages from artifacts which are fully consumed (all |
| public api) are omitted from the api and source jars and a |
| dependency list is generated instead.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Since</b>: <code>1.3.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CuseApiDependenciesForJavadoc.3E"></a><b><a name="useApiDependenciesForJavadoc"><useApiDependenciesForJavadoc></a></b></h4> |
| |
| <div>If this is set to <code>false</code> the javadoc generated will |
| always contain all APIs even the api from dependencies (if |
| <code>useApiDependencies</code>) is enabled. If this is set to |
| <code>true</code> the javadoc will not contain the API from |
| dependencies and exactly match the binary and source jars.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Since</b>: <code>1.5.2</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CvalidateFeatures.3E"></a><b><a name="validateFeatures"><validateFeatures></a></b></h4> |
| |
| <div>If set to <code>true</code> the features are validated against the |
| JSON schema.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul> |
| </section></section> |
| </section> |
| |
| |
| </div> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2023 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a> | <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |