blob: 323a79f112ae23da539ecede1687d11388080dee [file] [log] [blame]
<!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 &#x2013; 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">&lt;features&gt;</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">&lt;testFeatures&gt;</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">&lt;apiClassifierMappings&gt;</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">&lt;apiJavadocResources&gt;</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">&lt;apiName&gt;</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">&lt;apiRegionNameMappings&gt;</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">&lt;apiRepositoryUrls&gt;</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">&lt;apiResources&gt;</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">&lt;apiSourceResources&gt;</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">&lt;apiVersion&gt;</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">&lt;attachApiJars&gt;</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">&lt;enableLegacyVariableReplacement&gt;</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">&lt;enableProjectVariableReplacement&gt;</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 &quot;project.groupId&quot;,
&quot;project.artifactId&quot;, &quot;project.version&quot; and &quot;project.osgiVersion&quot;.<br /><b>Default value is</b>: <code>true</code>.<br /></td>
</tr>
<tr class="a">
<td align="left"><code><a href="#enabledToggles">&lt;enabledToggles&gt;</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">&lt;excludeRegions&gt;</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">&lt;failOnError&gt;</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">&lt;failOnMissingSourcesForJavadoc&gt;</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">&lt;featuresExcludes&gt;</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">&lt;featuresIncludes&gt;</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">&lt;generateApiJar&gt;</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">&lt;generateJavadocForAllApi&gt;</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">&lt;generateJavadocJar&gt;</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">&lt;generateSourceJar&gt;</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">&lt;generatedFeatures&gt;</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">&lt;generatedFeaturesExcludes&gt;</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">&lt;generatedFeaturesIncludes&gt;</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">&lt;ignoreJavadocErrors&gt;</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">&lt;includeRegions&gt;</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">&lt;includeResources&gt;</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">&lt;incrementalApis&gt;</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">&lt;jarStartOrder&gt;</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">&lt;javadocAdditionalExtensions&gt;</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">&lt;javadocClasspathHighestVersions&gt;</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
&quot;groupId:artifactId:type:classifier:version&quot;. 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">&lt;javadocClasspathRemovals&gt;</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
&quot;groupId:artifactId:type:classifier:version&quot;. 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">&lt;javadocClasspathTops&gt;</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
&quot;groupId:artifactId:type:classifier:version&quot;. 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">&lt;javadocIndex&gt;</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">&lt;javadocLinks&gt;</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">&lt;javadocSourceLevel&gt;</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">&lt;javadocTree&gt;</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">&lt;licenseDefaults&gt;</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 &quot;groupId:artifactId:type:classifier:version&quot;. After the
patter a &quot;=&quot; 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">&lt;licenseReport&gt;</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">&lt;licenseReportFooter&gt;</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">&lt;licenseReportHeader&gt;</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">&lt;manifestProperties&gt;</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">&lt;replacePropertyVariables&gt;</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">&lt;resourceFolders&gt;</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">&lt;selection&gt;</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">&lt;skipAddFeatureDependencies&gt;</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">&lt;skipAddJarToFeature&gt;</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">&lt;skipAddJarToTestFeature&gt;</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">&lt;skipAddTestFeatureDependencies&gt;</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">&lt;testFeaturesExcludes&gt;</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">&lt;testFeaturesIncludes&gt;</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">&lt;toggleApiOnly&gt;</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">&lt;useApiDependencies&gt;</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">&lt;useApiDependenciesForJavadoc&gt;</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">&lt;validateFeatures&gt;</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">&lt;apiClassifierMappings&gt;</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">&lt;apiJavadocResources&gt;</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">&lt;apiName&gt;</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">&lt;apiRegionNameMappings&gt;</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">&lt;apiRepositoryUrls&gt;</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">&lt;apiResources&gt;</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">&lt;apiSourceResources&gt;</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">&lt;apiVersion&gt;</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">&lt;attachApiJars&gt;</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">&lt;enableLegacyVariableReplacement&gt;</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">&lt;enableProjectVariableReplacement&gt;</a></b></h4>
<div>Enable the replacement of variables when reading a feature model.
The supported variables are &quot;project.groupId&quot;,
&quot;project.artifactId&quot;, &quot;project.version&quot; and &quot;project.osgiVersion&quot;.</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">&lt;enabledToggles&gt;</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">&lt;excludeRegions&gt;</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">&lt;failOnError&gt;</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">&lt;failOnMissingSourcesForJavadoc&gt;</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">&lt;features&gt;</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">&lt;featuresExcludes&gt;</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">&lt;featuresIncludes&gt;</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">&lt;generateApiJar&gt;</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">&lt;generateJavadocForAllApi&gt;</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">&lt;generateJavadocJar&gt;</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">&lt;generateSourceJar&gt;</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">&lt;generatedFeatures&gt;</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">&lt;generatedFeaturesExcludes&gt;</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">&lt;generatedFeaturesIncludes&gt;</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">&lt;ignoreJavadocErrors&gt;</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">&lt;includeRegions&gt;</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">&lt;includeResources&gt;</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">&lt;incrementalApis&gt;</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">&lt;jarStartOrder&gt;</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">&lt;javadocAdditionalExtensions&gt;</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">&lt;javadocClasspathHighestVersions&gt;</a></b></h4>
<div>A artifact patterns to match artifacts put on the javadoc
classpath. Follows the pattern
&quot;groupId:artifactId:type:classifier:version&quot;. 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">&lt;javadocClasspathRemovals&gt;</a></b></h4>
<div>A artifact patterns to match artifacts put on the javadoc
classpath. Follows the pattern
&quot;groupId:artifactId:type:classifier:version&quot;. 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">&lt;javadocClasspathTops&gt;</a></b></h4>
<div>A artifact patterns to match artifacts put on the javadoc
classpath. Follows the pattern
&quot;groupId:artifactId:type:classifier:version&quot;. 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">&lt;javadocIndex&gt;</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">&lt;javadocLinks&gt;</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">&lt;javadocSourceLevel&gt;</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">&lt;javadocTree&gt;</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">&lt;licenseDefaults&gt;</a></b></h4>
<div>A artifact patterns to match artifacts without a license. Follows
the pattern &quot;groupId:artifactId:type:classifier:version&quot;. After the
patter a &quot;=&quot; 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">&lt;licenseReport&gt;</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">&lt;licenseReportFooter&gt;</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">&lt;licenseReportHeader&gt;</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">&lt;manifestProperties&gt;</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">&lt;replacePropertyVariables&gt;</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">&lt;resourceFolders&gt;</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">&lt;selection&gt;</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">&lt;skipAddFeatureDependencies&gt;</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">&lt;skipAddJarToFeature&gt;</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">&lt;skipAddJarToTestFeature&gt;</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">&lt;skipAddTestFeatureDependencies&gt;</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">&lt;testFeatures&gt;</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">&lt;testFeaturesExcludes&gt;</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">&lt;testFeaturesIncludes&gt;</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">&lt;toggleApiOnly&gt;</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">&lt;useApiDependencies&gt;</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">&lt;useApiDependenciesForJavadoc&gt;</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">&lt;validateFeatures&gt;</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>&#169; 2023
<a href="https://www.apache.org/">The Apache Software Foundation</a> &vert; <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a>
</p>
</div>
</div>
</footer>
</body>
</html>