modules/ROOT/attachments/components/bundle-plugin-archives/bundle-plugin-6.0.0/baseline-mojo.html

<!DOCTYPE html>  <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="20190819" /> <meta http-equiv="Content-Language" content="en" /> <title>Maven Bundle Plugin – bundle:baseline</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.1.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.3.1.min.js"></script> </head> <body class="topBarDisabled"> <div class="container-fluid"> <div id="banner"> <div class="pull-left"> <div id="bannerLeft"> <h2>Maven Bundle 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: 2024-12-01 <span class="divider">|</span> </li> <li id="projectVersion">Version: 6.0.0 </li> </ul> </div> <div class="row-fluid"> <div id="leftColumn" class="span3"> <div class="well sidebar-nav"> <ul class="nav nav-list"> <li class="nav-header">Overview</li> <li> <a href="index.html" title="Introduction"> <i class="none"></i> Introduction</a> </li> <li> <a href="plugin-info.html" title="Goals"> <i class="none"></i> Goals</a> </li> <li> <a href="https://felix.apache.org/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html" title="Documentation"> <i class="none"></i> Documentation</a> </li> <li> <a href="https://felix.apache.org/documentation/faqs/apache-felix-bundle-plugin-faq.html" title="FAQ"> <i class="none"></i> FAQ</a> </li> <li> <a href="https://github.com/apache/felix-dev/blob/master/tools/maven-bundle-plugin/changelog.txt" title="Release Notes"> <i class="none"></i> Release Notes</a> </li> <li class="nav-header">Project Documentation</li> <li> <a href="project-info.html" title="Project Information"> <i class="icon-chevron-right"></i> Project Information</a> </li> <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="span9" > <div class="section"> <h2><a name="bundle:baseline"></a>bundle:baseline</h2> <p><b>Full name</b>:</p> <p>org.apache.felix:maven-bundle-plugin:6.0.0:baseline</p> <p><b>Description</b>:</p> <div>BND Baseline check between two bundles.</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>The goal is thread-safe and supports parallel builds.</li> <li>Since version: <tt>2.4.1</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>verify</tt>.</li> </ul> <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><b><a href="#comparisonArtifactId">comparisonArtifactId</a></b></td> <td><tt>String</tt></td> <td><tt>2.4.1</tt></td> <td>Artifact to compare the current code against.<br /><b>Default value is</b>: <tt>${project.artifactId}</tt>.<br /><b>User property is</b>: <tt>comparisonArtifactId</tt>.</td> </tr> <tr class="a"> <td><b><a href="#comparisonClassifier">comparisonClassifier</a></b></td> <td><tt>String</tt></td> <td><tt>2.4.1</tt></td> <td>Classifier for the artifact to compare the current code against.<br /><b>User property is</b>: <tt>comparisonClassifier</tt>.</td> </tr> <tr class="b"> <td><b><a href="#comparisonGroupId">comparisonGroupId</a></b></td> <td><tt>String</tt></td> <td><tt>2.4.1</tt></td> <td>Group id to compare the current code against.<br /><b>Default value is</b>: <tt>${project.groupId}</tt>.<br /><b>User property is</b>: <tt>comparisonGroupId</tt>.</td> </tr> <tr class="a"> <td><b><a href="#comparisonPackaging">comparisonPackaging</a></b></td> <td><tt>String</tt></td> <td><tt>2.4.1</tt></td> <td>Artifact to compare the current code against.<br /><b>Default value is</b>: <tt>${project.packaging}</tt>.<br /><b>User property is</b>: <tt>comparisonPackaging</tt>.</td> </tr> <tr class="b"> <td><b><a href="#comparisonVersion">comparisonVersion</a></b></td> <td><tt>String</tt></td> <td><tt>2.4.1</tt></td> <td>Version to compare the current code against.<br /><b>Default value is</b>: <tt>(,${project.version})</tt>.<br /><b>User property is</b>: <tt>comparisonVersion</tt>.</td> </tr> <tr class="a"> <td><b><a href="#failOnError">failOnError</a></b></td> <td><tt>boolean</tt></td> <td><tt>2.4.1</tt></td> <td>Whether to fail on errors.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>baseline.failOnError</tt>.</td> </tr> <tr class="b"> <td><b><a href="#failOnWarning">failOnWarning</a></b></td> <td><tt>boolean</tt></td> <td><tt>2.4.1</tt></td> <td>Whether to fail on warnings.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>baseline.failOnWarning</tt>.</td> </tr> <tr class="a"> <td><b><a href="#filters">filters</a></b></td> <td><tt>String[]</tt></td> <td><tt>2.4.1</tt></td> <td>A list of packages filter, if empty the whole bundle will be traversed. Values are specified in OSGi package instructions notation, e.g. <tt>!org.apache.felix.bundleplugin</tt>.<br /></td> </tr> <tr class="b"> <td><b><a href="#logResults">logResults</a></b></td> <td><tt>boolean</tt></td> <td><tt>2.4.1</tt></td> <td>Whether to log the results to the console or not, true by default.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>logResults</tt>.</td> </tr> <tr class="a"> <td><b><a href="#skip">skip</a></b></td> <td><tt>boolean</tt></td> <td><tt>2.4.1</tt></td> <td>Flag to easily skip execution.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>baseline.skip</tt>.</td> </tr> <tr class="b"> <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td> <td><tt>List</tt></td> <td><tt>2.4.1</tt></td> <td>Project types which this plugin supports.<br /></td> </tr> <tr class="a"> <td><b><a href="#xmlOutputFile">xmlOutputFile</a></b></td> <td><tt>File</tt></td> <td><tt>2.4.1</tt></td> <td>An XML output file to render to <tt>${project.build.directory}/baseline.xml</tt>.<br /><b>Default value is</b>: <tt>${project.build.directory}/baseline.xml</tt>.<br /></td> </tr> </table> </div> <div class="section"> <h3><a name="Parameter_Details"></a>Parameter Details</h3> <p><b><a name="comparisonArtifactId">comparisonArtifactId</a>:</b></p> <div>Artifact to compare the current code against.</div> <ul> <li><b>Type</b>: <tt>java.lang.String</tt></li> <li><b>Since</b>: <tt>2.4.1</tt></li> <li><b>Required</b>: <tt>No</tt></li> <li><b>User Property</b>: <tt>comparisonArtifactId</tt></li> <li><b>Default</b>: <tt>${project.artifactId}</tt></li> </ul><hr /> <p><b><a name="comparisonClassifier">comparisonClassifier</a>:</b></p> <div>Classifier for the artifact to compare the current code against.</div> <ul> <li><b>Type</b>: <tt>java.lang.String</tt></li> <li><b>Since</b>: <tt>2.4.1</tt></li> <li><b>Required</b>: <tt>No</tt></li> <li><b>User Property</b>: <tt>comparisonClassifier</tt></li> </ul><hr /> <p><b><a name="comparisonGroupId">comparisonGroupId</a>:</b></p> <div>Group id to compare the current code against.</div> <ul> <li><b>Type</b>: <tt>java.lang.String</tt></li> <li><b>Since</b>: <tt>2.4.1</tt></li> <li><b>Required</b>: <tt>No</tt></li> <li><b>User Property</b>: <tt>comparisonGroupId</tt></li> <li><b>Default</b>: <tt>${project.groupId}</tt></li> </ul><hr /> <p><b><a name="comparisonPackaging">comparisonPackaging</a>:</b></p> <div>Artifact to compare the current code against.</div> <ul> <li><b>Type</b>: <tt>java.lang.String</tt></li> <li><b>Since</b>: <tt>2.4.1</tt></li> <li><b>Required</b>: <tt>No</tt></li> <li><b>User Property</b>: <tt>comparisonPackaging</tt></li> <li><b>Default</b>: <tt>${project.packaging}</tt></li> </ul><hr /> <p><b><a name="comparisonVersion">comparisonVersion</a>:</b></p> <div>Version to compare the current code against.</div> <ul> <li><b>Type</b>: <tt>java.lang.String</tt></li> <li><b>Since</b>: <tt>2.4.1</tt></li> <li><b>Required</b>: <tt>No</tt></li> <li><b>User Property</b>: <tt>comparisonVersion</tt></li> <li><b>Default</b>: <tt>(,${project.version})</tt></li> </ul><hr /> <p><b><a name="failOnError">failOnError</a>:</b></p> <div>Whether to fail on errors.</div> <ul> <li><b>Type</b>: <tt>boolean</tt></li> <li><b>Since</b>: <tt>2.4.1</tt></li> <li><b>Required</b>: <tt>No</tt></li> <li><b>User Property</b>: <tt>baseline.failOnError</tt></li> <li><b>Default</b>: <tt>true</tt></li> </ul><hr /> <p><b><a name="failOnWarning">failOnWarning</a>:</b></p> <div>Whether to fail on warnings.</div> <ul> <li><b>Type</b>: <tt>boolean</tt></li> <li><b>Since</b>: <tt>2.4.1</tt></li> <li><b>Required</b>: <tt>No</tt></li> <li><b>User Property</b>: <tt>baseline.failOnWarning</tt></li> <li><b>Default</b>: <tt>false</tt></li> </ul><hr /> <p><b><a name="filters">filters</a>:</b></p> <div>A list of packages filter, if empty the whole bundle will be traversed. Values are specified in OSGi package instructions notation, e.g. <tt>!org.apache.felix.bundleplugin</tt>.</div> <ul> <li><b>Type</b>: <tt>java.lang.String[]</tt></li> <li><b>Since</b>: <tt>2.4.1</tt></li> <li><b>Required</b>: <tt>No</tt></li> </ul><hr /> <p><b><a name="logResults">logResults</a>:</b></p> <div>Whether to log the results to the console or not, true by default.</div> <ul> <li><b>Type</b>: <tt>boolean</tt></li> <li><b>Since</b>: <tt>2.4.1</tt></li> <li><b>Required</b>: <tt>No</tt></li> <li><b>User Property</b>: <tt>logResults</tt></li> <li><b>Default</b>: <tt>true</tt></li> </ul><hr /> <p><b><a name="skip">skip</a>:</b></p> <div>Flag to easily skip execution.</div> <ul> <li><b>Type</b>: <tt>boolean</tt></li> <li><b>Since</b>: <tt>2.4.1</tt></li> <li><b>Required</b>: <tt>No</tt></li> <li><b>User Property</b>: <tt>baseline.skip</tt></li> <li><b>Default</b>: <tt>false</tt></li> </ul><hr /> <p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p> <div>Project types which this plugin supports.</div> <ul> <li><b>Type</b>: <tt>java.util.List</tt></li> <li><b>Since</b>: <tt>2.4.1</tt></li> <li><b>Required</b>: <tt>No</tt></li> </ul><hr /> <p><b><a name="xmlOutputFile">xmlOutputFile</a>:</b></p> <div>An XML output file to render to <tt>${project.build.directory}/baseline.xml</tt>.</div> <ul> <li><b>Type</b>: <tt>java.io.File</tt></li> <li><b>Since</b>: <tt>2.4.1</tt></li> <li><b>Required</b>: <tt>No</tt></li> <li><b>Default</b>: <tt>${project.build.directory}/baseline.xml</tt></li> </ul> </div> </div> </div> </div> </div> <hr/> <footer> <div class="container-fluid"> <div class="row-fluid"> <p >Copyright © 2006–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved. </p> </div> </div> </footer> </body> </html>

modules/ROOT/attachments/components/bundle-plugin-archives/bundle-plugin-6.0.0/baseline-mojo.html (309 lines of code) (raw):