| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2020-04-18 |
| | 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="20200418" /> |
| <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"> |
| <div class="container-fluid"> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h2>Apache Sling OSGi Feature Maven Plugin</h2> |
| </div> |
| </div> |
| <div class="pull-right"></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2020-04-18<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 1.2.0</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" > |
| |
| |
| <div class="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.2.0: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: <tt>test</tt>.</li> |
| |
| <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>package</tt>.</li> |
| </ul> |
| |
| <div class="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><tt><a href="#features"><features></a></tt></td> |
| |
| <td><tt>File</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Directory containing feature files<br /><b>Default value is</b>: <tt>src/main/features</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#testFeatures"><testFeatures></a></tt></td> |
| |
| <td><tt>File</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Directory containing test feature files.<br /><b>Default value is</b>: <tt>src/test/features</tt>.<br /></td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="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><tt><a href="#apiClassifierMappings"><apiClassifierMappings></a></tt></td> |
| |
| <td><tt>Map</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Mapping for the feature classifier to a user defined name<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#apiJavadocResources"><apiJavadocResources></a></tt></td> |
| |
| <td><tt>List</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Additional resources for the api javadoc jar<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#apiRegionNameMappings"><apiRegionNameMappings></a></tt></td> |
| |
| <td><tt>Map</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Mapping for an api region name to a user defined name<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#apiResources"><apiResources></a></tt></td> |
| |
| <td><tt>List</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Additional resources for the api jar<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#apiSourceResources"><apiSourceResources></a></tt></td> |
| |
| <td><tt>List</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Additional resources for the api source jar<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#apiVersion"><apiVersion></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.2.0</tt></td> |
| |
| <td>Optional version to be put into the manifest of the created jars<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#attachApiJars"><attachApiJars></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If enabled, the created api jars will be attached to the project<br /><b>Default value is</b>: <tt>true</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#excludeRegions"><excludeRegions></a></tt></td> |
| |
| <td><tt>Set</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Names of the regions to exclude, by default no regions is excluded.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#featuresExcludes"><featuresExcludes></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></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="a"> |
| |
| <td><tt><a href="#featuresIncludes"><featuresIncludes></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></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>: <tt>**/*.json</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#generateApiJar"><generateApiJar></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Generate api jar<br /><b>Default value is</b>: <tt>true</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#generateJavadocJar"><generateJavadocJar></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Generate the javadoc jar<br /><b>Default value is</b>: <tt>true</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#generateSourceJar"><generateSourceJar></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Generate the sources jar<br /><b>Default value is</b>: <tt>true</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#generatedFeatures"><generatedFeatures></a></tt></td> |
| |
| <td><tt>File</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Directory containing generated feature files<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#generatedFeaturesExcludes"><generatedFeaturesExcludes></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></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><tt><a href="#generatedFeaturesIncludes"><generatedFeaturesIncludes></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></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>: <tt>**/*.json</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#ignoreJavadocErrors"><ignoreJavadocErrors></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Ignore errors in javadoc generation<br /><b>Default value is</b>: <tt>false</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#includeRegions"><includeRegions></a></tt></td> |
| |
| <td><tt>Set</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Names of the regions to include, by default all regions are |
| included.<br /><b>Default value is</b>: <tt>*</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#includeResources"><includeResources></a></tt></td> |
| |
| <td><tt>String[]</tt></td> |
| |
| <td><tt>-</tt></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 <tt>#resourceFolders</tt><br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#incrementalApis"><incrementalApis></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></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>: <tt>true</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#jarStartOrder"><jarStartOrder></a></tt></td> |
| |
| <td><tt>int</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>The start level for the attached jar/bundle.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#javadocLinks"><javadocLinks></a></tt></td> |
| |
| <td><tt>String[]</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>List of javadoc links used in the javadoc generation.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#javadocSourceLevel"><javadocSourceLevel></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>(no description)<br /><b>Default value is</b>: <tt>8</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#licenseDefaults"><licenseDefaults></a></tt></td> |
| |
| <td><tt>List</tt></td> |
| |
| <td><tt>1.2.0</tt></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><tt><a href="#licenseReport"><licenseReport></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.2.0</tt></td> |
| |
| <td>Create a license report file. This is the name of that file within |
| the jar<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#licenseReportFooter"><licenseReportFooter></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.2.0</tt></td> |
| |
| <td>Footer added at the bottom of the license report<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#licenseReportHeader"><licenseReportHeader></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.2.0</tt></td> |
| |
| <td>Header added on top of the license report<br /><b>Default value is</b>: <tt>This archive contains files from the following artifacts:</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#resourceFolders"><resourceFolders></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>1.2.0</tt></td> |
| |
| <td>Comma separated list of folders where files are renamed.<br /><b>Default value is</b>: <tt>META-INF,SLING-INF</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#selection"><selection></a></tt></td> |
| |
| <td><tt>FeatureSelectionConfig</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Select the features for api generation. Separate api jars will be |
| generated for each feature.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#skipAddFeatureDependencies"><skipAddFeatureDependencies></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If set to <tt>true</tt> the artifacts from the feature are not |
| as dependencies to the project.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#skipAddJarToFeature"><skipAddJarToFeature></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If set to <tt>true</tt> the main jar artifact is not added to |
| the feature.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#skipAddJarToTestFeature"><skipAddJarToTestFeature></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If set to <tt>true</tt> the main jar artifact is not added to |
| the test feature.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#skipAddTestFeatureDependencies"><skipAddTestFeatureDependencies></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If set to <tt>true</tt> the artifacts from the test feature are |
| not as dependencies to the project.<br /><b>Default value is</b>: <tt>true</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#testFeaturesExcludes"><testFeaturesExcludes></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Comma separated list of excludes for the test features.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#testFeaturesIncludes"><testFeaturesIncludes></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Comma separated list of includes for the test features.<br /><b>Default value is</b>: <tt>**/*.json</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#validateFeatures"><validateFeatures></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If set to <tt>true</tt> the features are validated against the |
| JSON schema.<br /><b>Default value is</b>: <tt>true</tt>.<br /></td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="section"> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| |
| <div class="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>: <tt>java.util.Map</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.util.List</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.util.Map</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.util.List</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.util.List</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.2.0</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.util.Set</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.io.File</tt></li> |
| |
| <li><b>Required</b>: <tt>Yes</tt></li> |
| |
| <li><b>Default</b>: <tt>src/main/features</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>**/*.json</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.io.File</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>**/*.json</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.util.Set</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>*</tt></li> |
| </ul><hr /></div> |
| <div class="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 <tt>#resourceFolders</tt></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String[]</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>int</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.lang.String[]</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CjavadocSourceLevel.3E"></a><b><a name="javadocSourceLevel"><javadocSourceLevel></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>8</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.util.List</tt></li> |
| |
| <li><b>Since</b>: <tt>1.2.0</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.2.0</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.2.0</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.2.0</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>This archive contains files from the following artifacts:</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Since</b>: <tt>1.2.0</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>META-INF,SLING-INF</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>org.apache.sling.feature.maven.mojos.FeatureSelectionConfig</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CskipAddFeatureDependencies.3E"></a><b><a name="skipAddFeatureDependencies"><skipAddFeatureDependencies></a></b></h4> |
| |
| <div>If set to <tt>true</tt> the artifacts from the feature are not |
| as dependencies to the project.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CskipAddJarToFeature.3E"></a><b><a name="skipAddJarToFeature"><skipAddJarToFeature></a></b></h4> |
| |
| <div>If set to <tt>true</tt> the main jar artifact is not added to |
| the feature.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CskipAddJarToTestFeature.3E"></a><b><a name="skipAddJarToTestFeature"><skipAddJarToTestFeature></a></b></h4> |
| |
| <div>If set to <tt>true</tt> the main jar artifact is not added to |
| the test feature.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CskipAddTestFeatureDependencies.3E"></a><b><a name="skipAddTestFeatureDependencies"><skipAddTestFeatureDependencies></a></b></h4> |
| |
| <div>If set to <tt>true</tt> the artifacts from the test feature are |
| not as dependencies to the project.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.io.File</tt></li> |
| |
| <li><b>Required</b>: <tt>Yes</tt></li> |
| |
| <li><b>Default</b>: <tt>src/test/features</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /></div> |
| <div class="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>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>**/*.json</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CvalidateFeatures.3E"></a><b><a name="validateFeatures"><validateFeatures></a></b></h4> |
| |
| <div>If set to <tt>true</tt> the features are validated against the |
| JSON schema.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul> |
| </div></div> |
| </div> |
| |
| |
| </div> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>Copyright ©2007–2020 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a>. |
| All rights reserved.</p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |