Modified: maven/website/components/plugins-archives/maven-jar-plugin-LATEST/jar-mojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-jar-plugin-LATEST/jar-mojo.html (original) +++ maven/website/components/plugins-archives/maven-jar-plugin-LATEST/jar-mojo.html Mon Sep 12 16:00:29 2022 @@ -1,486 +1,486 @@ -<!DOCTYPE html> -<!-- - | Generated by Apache Maven Doxia Site Renderer 1.8.1 from target\generated-site\xdoc/jar-mojo.xml at 2022-01-08 - | Rendered using Apache Maven Fluido Skin 1.7 ---> -<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="20220108" /> - <meta http-equiv="Content-Language" content="en" /> - <title>Apache Maven JAR Plugin – jar:jar</title> - <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.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.7.min.js"></script> - <!-- Google Analytics --> - <script type="text/javascript"> - var _gaq = _gaq || []; - _gaq.push(['_setAccount', 'UA-140879-1']); - _gaq.push(['_trackPageview']); - (function() { - var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; - ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); - })(); - </script> - </head> - <body class="topBarDisabled"> - <div class="container-fluid"> - <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven JAR Plugin"/></a></div> - <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt=""/></a></div> - <div class="clear"><hr/></div> - </div> - - <div id="breadcrumbs"> - <ul class="breadcrumb"> - <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> - <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class=""><a href="../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li> - <li class=""><a href="index.html" title="Apache Maven JAR Plugin">Apache Maven JAR Plugin</a><span class="divider">/</span></li> - <li class="active ">jar:jar</li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2022-01-08</li> - <li id="projectVersion" class="pull-right">Version: 3.2.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><a href="usage.html" title="Usage"><span class="none"></span>Usage</a></li> - <li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> - <li><a href="http://www.apache.org/licenses/"; class="externalLink" title="License"><span class="none"></span>License</a></li> - <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li> - <li class="nav-header">Examples</li> - <li><a href="../../shared/maven-archiver/examples/classpath.html" title="Creating an Executable JAR File"><span class="none"></span>Creating an Executable JAR File</a></li> - <li><a href="examples/manifest-customization.html" title="Manifest Customization"><span class="none"></span>Manifest Customization</a></li> - <li><a href="../../shared/maven-archiver/examples/manifestFile.html" title="Using Your Own Manifest File"><span class="none"></span>Using Your Own Manifest File</a></li> - <li><a href="examples/attached-jar.html" title="Additional attached JAR"><span class="none"></span>Additional attached JAR</a></li> - <li><a href="examples/create-test-jar.html" title="Create Test JAR"><span class="none"></span>Create Test JAR</a></li> - <li><a href="examples/include-exclude.html" title="Include/Exclude content"><span class="none"></span>Include/Exclude content</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> - <li class="nav-header">Maven Projects</li> - <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> - <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> - <li><a href="../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li> - <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> - <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> - <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> - <li><a href="../index.html" title="Plugins"><span class="none"></span>Plugins</a></li> - <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> - <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> - <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> - <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> - <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> - <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> - <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> - <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> - <li class="nav-header">ASF</li> - <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> - <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> - <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> - <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> -</ul> -<form id="search-form" action="https://www.google.com/search"; method="get" > - <input value="maven.apache.org/plugins/maven-jar-plugin/" name="sitesearch" type="hidden"/> - <input class="search-query" name="q" id="query" type="text" /> -</form> -<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> - <hr /> - <div id="poweredBy"> - <div class="clear"></div> - <div class="clear"></div> - <div id="twitter"> - <a href="https://twitter.com/ASFMavenProject"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ASFMavenProject</a> - <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> - </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="jar:jar"></a>jar:jar</h2> - -<p><b>Full name</b>:</p> - -<p>org.apache.maven.plugins:maven-jar-plugin:3.2.2:jar</p> - -<p><b>Description</b>:</p> - -<div>Build a JAR from the current project.</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>runtime</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="#classesDirectory"><classesDirectory></a></tt></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>Directory containing the classes and resource files that should be -packaged into the JAR.<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#outputDirectory"><outputDirectory></a></tt></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>Directory containing the generated JAR.<br /><b>Default value is</b>: <tt>${project.build.directory}</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="#archive"><archive></a></tt></td> - -<td><tt>MavenArchiveConfiguration</tt></td> - -<td><tt>-</tt></td> - -<td>The archive configuration to use. See <a class="externalLink" href="http://maven.apache.org/shared/maven-archiver/index.html";>Maven -Archiver Reference</a>.<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#classifier"><classifier></a></tt></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>Classifier to add to the artifact generated. If given, the artifact -will be attached as a supplemental artifact. If not given this will -create the main artifact which is the default behavior. If you try -to do that a second time without using a classifier the build will -fail.<br /></td> - </tr> - -<tr class="b"> - -<td><tt><a href="#excludes"><excludes></a></tt></td> - -<td><tt>String[]</tt></td> - -<td><tt>-</tt></td> - -<td>List of files to exclude. Specified as fileset patterns which are -relative to the input directory whose contents is being packaged -into the JAR.<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#forceCreation"><forceCreation></a></tt></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>Require the jar plugin to build a new JAR even if none of the -contents appear to have changed. By default, this plugin looks to -see if the output jar exists and inputs have not changed. If these -conditions are true, the plugin skips creation of the jar. This -does not work when other plugins, like the maven-shade-plugin, are -configured to post-process the jar. This plugin can not detect the -post-processing, and so leaves the post-processed jar in place. -This can lead to failures when those plugins do not expect to find -their own output as an input. Set this parameter to <tt>true</tt> -to avoid these problems by forcing this plugin to recreate the jar -every time.<br /> -Starting with <b>3.0.0</b> the property has been renamed from -<tt>jar.forceCreation</tt> to -<tt>maven.jar.forceCreation</tt>.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>maven.jar.forceCreation</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><tt><a href="#includes"><includes></a></tt></td> - -<td><tt>String[]</tt></td> - -<td><tt>-</tt></td> - -<td>List of files to include. Specified as fileset patterns which are -relative to the input directory whose contents is being packaged -into the JAR.<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#outputTimestamp"><outputTimestamp></a></tt></td> - -<td><tt>String</tt></td> - -<td><tt>3.2.0</tt></td> - -<td>Timestamp for reproducible output archive entries, either formatted -as ISO 8601 <tt>yyyy-MM-dd'T'HH:mm:ssXXX</tt> or as an int -representing seconds since the epoch (like <a class="externalLink" href="https://reproducible-builds.org/docs/source-date-epoch/";>SOURCE_DATE_EPOCH</a>).<br /><b>Default value is</b>: <tt>${project.build.outputTimestamp}</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><tt><a href="#skipIfEmpty"><skipIfEmpty></a></tt></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>Skip creating empty archives.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><tt><a href="#useDefaultManifestFile"><useDefaultManifestFile></a></tt></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td><b>Deprecated.</b> For version 3.0.0 this parameter is only defined here to break the -build if you use it!<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>jar.useDefaultManifestFile</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.3Carchive.3E"></a><b><a name="archive"><archive></a></b></h4> - -<div>The archive configuration to use. See <a class="externalLink" href="http://maven.apache.org/shared/maven-archiver/index.html";>Maven -Archiver Reference</a>.</div> - -<ul> - -<li><b>Type</b>: <tt>org.apache.maven.archiver.MavenArchiveConfiguration</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CclassesDirectory.3E"></a><b><a name="classesDirectory"><classesDirectory></a></b></h4> - -<div>Directory containing the classes and resource files that should be -packaged into the JAR.</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>${project.build.outputDirectory}</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3Cclassifier.3E"></a><b><a name="classifier"><classifier></a></b></h4> - -<div>Classifier to add to the artifact generated. If given, the artifact -will be attached as a supplemental artifact. If not given this will -create the main artifact which is the default behavior. If you try -to do that a second time without using a classifier the build will -fail.</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.3Cexcludes.3E"></a><b><a name="excludes"><excludes></a></b></h4> - -<div>List of files to exclude. Specified as fileset patterns which are -relative to the input directory whose contents is being packaged -into the JAR.</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.3CforceCreation.3E"></a><b><a name="forceCreation"><forceCreation></a></b></h4> - -<div>Require the jar plugin to build a new JAR even if none of the -contents appear to have changed. By default, this plugin looks to -see if the output jar exists and inputs have not changed. If these -conditions are true, the plugin skips creation of the jar. This -does not work when other plugins, like the maven-shade-plugin, are -configured to post-process the jar. This plugin can not detect the -post-processing, and so leaves the post-processed jar in place. -This can lead to failures when those plugins do not expect to find -their own output as an input. Set this parameter to <tt>true</tt> -to avoid these problems by forcing this plugin to recreate the jar -every time.<br /> -Starting with <b>3.0.0</b> the property has been renamed from -<tt>jar.forceCreation</tt> to -<tt>maven.jar.forceCreation</tt>.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>maven.jar.forceCreation</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3Cincludes.3E"></a><b><a name="includes"><includes></a></b></h4> - -<div>List of files to include. Specified as fileset patterns which are -relative to the input directory whose contents is being packaged -into the JAR.</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.3CoutputDirectory.3E"></a><b><a name="outputDirectory"><outputDirectory></a></b></h4> - -<div>Directory containing the generated JAR.</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>${project.build.directory}</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CoutputTimestamp.3E"></a><b><a name="outputTimestamp"><outputTimestamp></a></b></h4> - -<div>Timestamp for reproducible output archive entries, either formatted -as ISO 8601 <tt>yyyy-MM-dd'T'HH:mm:ssXXX</tt> or as an int -representing seconds since the epoch (like <a class="externalLink" href="https://reproducible-builds.org/docs/source-date-epoch/";>SOURCE_DATE_EPOCH</a>).</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Since</b>: <tt>3.2.0</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>Default</b>: <tt>${project.build.outputTimestamp}</tt></li> - </ul><hr /></div> -<div class="section"> -<h4><a name="a.3CskipIfEmpty.3E"></a><b><a name="skipIfEmpty"><skipIfEmpty></a></b></h4> - -<div>Skip creating empty archives.</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.3CuseDefaultManifestFile.3E"></a><b><a name="useDefaultManifestFile"><useDefaultManifestFile></a></b></h4> - -<div><b>Deprecated.</b> For version 3.0.0 this parameter is only defined here to break the -build if you use it!</div> - -<div>Using this property will fail your build cause it has been removed -from the plugin configuration. See the <a class="externalLink" href="https://maven.apache.org/plugins/maven-jar-plugin/";>Major -Version Upgrade to version 3.0.0</a> for the plugin.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>jar.useDefaultManifestFile</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul> - </div></div> - </div> - - - </div> - </div> - </div> - <hr/> - <footer> - <div class="container-fluid"> - <div class="row-fluid"> - <p>Copyright ©2002–2022 -<a href="https://www.apache.org/";>The Apache Software Foundation</a>. -All rights reserved.</p> - </div> - </div> - </footer> - </body> +<!DOCTYPE html> + + +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target/generated-site/xdoc/jar-mojo.xml at 2022-09-12 + | Rendered using Apache Maven Fluido Skin 1.11.1 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> + <title>Apache Maven JAR Plugin – jar:jar</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.1.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script src="./js/apache-maven-fluido-1.11.1.min.js"></script> + + <!-- Matomo --> + <script> + var _paq = window._paq = window._paq || []; + _paq.push(['disableCookies']); + _paq.push(['trackPageView']); + _paq.push(['enableLinkTracking']); + + (function() { + var u="https://analytics.apache.org/";; + _paq.push(['setTrackerUrl', u+'/matomo.php']); + _paq.push(['setSiteId', '3']); + var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; + g.async=true; g.src=u+'/matomo.js'; s.parentNode.insertBefore(g,s); + })(); + </script> + <!-- End Matomo Code --> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <header> + <div id="banner"> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven JAR Plugin" style="" /></a></div> + <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> + <li class=""><a href="../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li> + <li class=""><a href="index.html" title="Apache Maven JAR Plugin">Apache Maven JAR Plugin</a><span class="divider">/</span></li> + <li class="active ">jar:jar</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2022-09-12</li> + <li id="projectVersion" class="pull-right">Version: 3.3.0</li> + </ul> + </div> + </header> + <div class="row-fluid"> + <header id="leftColumn" class="span2"> + <nav 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><a href="usage.html" title="Usage"><span class="none"></span>Usage</a></li> + <li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> + <li><a href="http://www.apache.org/licenses/"; class="externalLink" title="License"><span class="none"></span>License</a></li> + <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li> + <li class="nav-header">Examples</li> + <li><a href="../../shared/maven-archiver/examples/classpath.html" title="Creating an Executable JAR File"><span class="none"></span>Creating an Executable JAR File</a></li> + <li><a href="examples/manifest-customization.html" title="Manifest Customization"><span class="none"></span>Manifest Customization</a></li> + <li><a href="../../shared/maven-archiver/examples/manifestFile.html" title="Using Your Own Manifest File"><span class="none"></span>Using Your Own Manifest File</a></li> + <li><a href="examples/attached-jar.html" title="Additional attached JAR"><span class="none"></span>Additional attached JAR</a></li> + <li><a href="examples/create-test-jar.html" title="Create Test JAR"><span class="none"></span>Create Test JAR</a></li> + <li><a href="examples/include-exclude.html" title="Include/Exclude content"><span class="none"></span>Include/Exclude content</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> + <li class="nav-header">Maven Projects</li> + <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> + <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> + <li><a href="../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li> + <li><a href="../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li> + <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> + <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> + <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> + <li><a href="../index.html" title="Plugins"><span class="none"></span>Plugins</a></li> + <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> + <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> + <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> + <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> + <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> + <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> + <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> + <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> + <li class="nav-header">ASF</li> + <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> + <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> + <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> + </ul> + </nav> + <div class="well sidebar-nav"> + <div id="poweredBy"> + <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> + </header> + <main id="bodyColumn" class="span10" > + + + <section> +<h2><a name="jar:jar"></a>jar:jar</h2> + +<p><b>Full name</b>:</p> + +<p>org.apache.maven.plugins:maven-jar-plugin:3.3.0:jar</p> + +<p><b>Description</b>:</p> + +<div>Build a JAR from the current project.</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>runtime</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="#classesDirectory"><classesDirectory></a></code></td> + +<td><code>File</code></td> + +<td><code>-</code></td> + +<td>Directory containing the classes and resource files that should be +packaged into the JAR.<br /><b>Default value is</b>: <code>${project.build.outputDirectory}</code>.<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#outputDirectory"><outputDirectory></a></code></td> + +<td><code>File</code></td> + +<td><code>-</code></td> + +<td>Directory containing the generated JAR.<br /><b>Default value is</b>: <code>${project.build.directory}</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="#archive"><archive></a></code></td> + +<td><code>MavenArchiveConfiguration</code></td> + +<td><code>-</code></td> + +<td>The archive configuration to use. See <a class="externalLink" href="http://maven.apache.org/shared/maven-archiver/index.html";>Maven +Archiver Reference</a>.<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#classifier"><classifier></a></code></td> + +<td><code>String</code></td> + +<td><code>-</code></td> + +<td>Classifier to add to the artifact generated. If given, the artifact +will be attached as a supplemental artifact. If not given this will +create the main artifact which is the default behavior. If you try +to do that a second time without using a classifier the build will +fail.<br /></td> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#excludes"><excludes></a></code></td> + +<td><code>String[]</code></td> + +<td><code>-</code></td> + +<td>List of files to exclude. Specified as fileset patterns which are +relative to the input directory whose contents is being packaged +into the JAR.<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#forceCreation"><forceCreation></a></code></td> + +<td><code>boolean</code></td> + +<td><code>-</code></td> + +<td>Require the jar plugin to build a new JAR even if none of the +contents appear to have changed. By default, this plugin looks to +see if the output jar exists and inputs have not changed. If these +conditions are true, the plugin skips creation of the jar. This +does not work when other plugins, like the maven-shade-plugin, are +configured to post-process the jar. This plugin can not detect the +post-processing, and so leaves the post-processed jar in place. +This can lead to failures when those plugins do not expect to find +their own output as an input. Set this parameter to <code>true</code> +to avoid these problems by forcing this plugin to recreate the jar +every time.<br /> +Starting with <b>3.0.0</b> the property has been renamed from +<code>jar.forceCreation</code> to +<code>maven.jar.forceCreation</code>.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>maven.jar.forceCreation</code>.<br /></td> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#includes"><includes></a></code></td> + +<td><code>String[]</code></td> + +<td><code>-</code></td> + +<td>List of files to include. Specified as fileset patterns which are +relative to the input directory whose contents is being packaged +into the JAR.<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#outputTimestamp"><outputTimestamp></a></code></td> + +<td><code>String</code></td> + +<td><code>3.2.0</code></td> + +<td>Timestamp for reproducible output archive entries, either formatted +as ISO 8601 extended offset date-time (e.g. in UTC such as +'2011-12-03T10:15:30Z' or with an offset +'2019-10-05T20:37:42+06:00'), or as an int representing seconds +since the epoch (like <a class="externalLink" href="https://reproducible-builds.org/docs/source-date-epoch/";>SOURCE_DATE_EPOCH</a>).<br /><b>Default value is</b>: <code>${project.build.outputTimestamp}</code>.<br /></td> + </tr> + +<tr class="b"> + +<td align="left"><code><a href="#skipIfEmpty"><skipIfEmpty></a></code></td> + +<td><code>boolean</code></td> + +<td><code>-</code></td> + +<td>Skip creating empty archives.<br /><b>Default value is</b>: <code>false</code>.<br /></td> + </tr> + +<tr class="a"> + +<td align="left"><code><a href="#useDefaultManifestFile"><useDefaultManifestFile></a></code></td> + +<td><code>boolean</code></td> + +<td><code>-</code></td> + +<td><b>Deprecated.</b> For version 3.0.0 this parameter is only defined here to break the +build if you use it!<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>jar.useDefaultManifestFile</code>.<br /></td> + </tr> + </table> + </section> + <section> +<h3><a name="Parameter_Details"></a>Parameter Details</h3> + <section> +<h4><a name="a.3Carchive.3E"></a><b><a name="archive"><archive></a></b></h4> + +<div>The archive configuration to use. See <a class="externalLink" href="http://maven.apache.org/shared/maven-archiver/index.html";>Maven +Archiver Reference</a>.</div> + +<ul> + +<li><b>Type</b>: <code>org.apache.maven.archiver.MavenArchiveConfiguration</code></li> + +<li><b>Required</b>: <code>No</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CclassesDirectory.3E"></a><b><a name="classesDirectory"><classesDirectory></a></b></h4> + +<div>Directory containing the classes and resource files that should be +packaged into the JAR.</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>${project.build.outputDirectory}</code></li> + </ul><hr /></section><section> +<h4><a name="a.3Cclassifier.3E"></a><b><a name="classifier"><classifier></a></b></h4> + +<div>Classifier to add to the artifact generated. If given, the artifact +will be attached as a supplemental artifact. If not given this will +create the main artifact which is the default behavior. If you try +to do that a second time without using a classifier the build will +fail.</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.3Cexcludes.3E"></a><b><a name="excludes"><excludes></a></b></h4> + +<div>List of files to exclude. Specified as fileset patterns which are +relative to the input directory whose contents is being packaged +into the JAR.</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.3CforceCreation.3E"></a><b><a name="forceCreation"><forceCreation></a></b></h4> + +<div>Require the jar plugin to build a new JAR even if none of the +contents appear to have changed. By default, this plugin looks to +see if the output jar exists and inputs have not changed. If these +conditions are true, the plugin skips creation of the jar. This +does not work when other plugins, like the maven-shade-plugin, are +configured to post-process the jar. This plugin can not detect the +post-processing, and so leaves the post-processed jar in place. +This can lead to failures when those plugins do not expect to find +their own output as an input. Set this parameter to <code>true</code> +to avoid these problems by forcing this plugin to recreate the jar +every time.<br /> +Starting with <b>3.0.0</b> the property has been renamed from +<code>jar.forceCreation</code> to +<code>maven.jar.forceCreation</code>.</div> + +<ul> + +<li><b>Type</b>: <code>boolean</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>maven.jar.forceCreation</code></li> + +<li><b>Default</b>: <code>false</code></li> + </ul><hr /></section><section> +<h4><a name="a.3Cincludes.3E"></a><b><a name="includes"><includes></a></b></h4> + +<div>List of files to include. Specified as fileset patterns which are +relative to the input directory whose contents is being packaged +into the JAR.</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.3CoutputDirectory.3E"></a><b><a name="outputDirectory"><outputDirectory></a></b></h4> + +<div>Directory containing the generated JAR.</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>${project.build.directory}</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CoutputTimestamp.3E"></a><b><a name="outputTimestamp"><outputTimestamp></a></b></h4> + +<div>Timestamp for reproducible output archive entries, either formatted +as ISO 8601 extended offset date-time (e.g. in UTC such as +'2011-12-03T10:15:30Z' or with an offset +'2019-10-05T20:37:42+06:00'), or as an int representing seconds +since the epoch (like <a class="externalLink" href="https://reproducible-builds.org/docs/source-date-epoch/";>SOURCE_DATE_EPOCH</a>).</div> + +<ul> + +<li><b>Type</b>: <code>java.lang.String</code></li> + +<li><b>Since</b>: <code>3.2.0</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>Default</b>: <code>${project.build.outputTimestamp}</code></li> + </ul><hr /></section><section> +<h4><a name="a.3CskipIfEmpty.3E"></a><b><a name="skipIfEmpty"><skipIfEmpty></a></b></h4> + +<div>Skip creating empty archives.</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.3CuseDefaultManifestFile.3E"></a><b><a name="useDefaultManifestFile"><useDefaultManifestFile></a></b></h4> + +<div><b>Deprecated.</b> For version 3.0.0 this parameter is only defined here to break the +build if you use it!</div> + +<div>Using this property will fail your build cause it has been removed +from the plugin configuration. See the <a class="externalLink" href="https://maven.apache.org/plugins/maven-jar-plugin/";>Major +Version Upgrade to version 3.0.0</a> for the plugin.</div> + +<ul> + +<li><b>Type</b>: <code>boolean</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>User Property</b>: <code>jar.useDefaultManifestFile</code></li> + +<li><b>Default</b>: <code>false</code></li> + </ul> + </section></section> + </section> + + + </main> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>© 2002–2022 +<a href="https://www.apache.org/";>The Apache Software Foundation</a> +</p> + </div> + </div> + </footer> +<script> + if(anchors) { + anchors.add(); + } +</script> + </body> </html> \ No newline at end of file
