Modified: maven/website/components/plugins-archives/maven-jar-plugin-LATEST/apidocs/org/apache/maven/plugins/jar/AbstractJarMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-jar-plugin-LATEST/apidocs/org/apache/maven/plugins/jar/AbstractJarMojo.html (original) +++ maven/website/components/plugins-archives/maven-jar-plugin-LATEST/apidocs/org/apache/maven/plugins/jar/AbstractJarMojo.html Mon Sep 12 16:00:29 2022 @@ -1,465 +1,465 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>AbstractJarMojo (Apache Maven JAR Plugin 3.2.2 API)</title> -<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="AbstractJarMojo (Apache Maven JAR Plugin 3.2.2 API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10,"i2":6,"i3":6,"i4":10,"i5":10,"i6":6,"i7":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../../org/apache/maven/plugins/jar/package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/AbstractJarMojo.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../../index-all.html">Index</a></li> -<li><a href="../../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../../org/apache/maven/plugins/jar/HelpMojo.html" title="class in org.apache.maven.plugins.jar"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../../index.html?org/apache/maven/plugins/jar/AbstractJarMojo.html" target="_top">Frames</a></li> -<li><a href="AbstractJarMojo.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.maven.plugins.jar</div> -<h2 title="Class AbstractJarMojo" class="title">Class AbstractJarMojo</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> -<li> -<ul class="inheritance"> -<li><a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true"; title="class or interface in org.apache.maven.plugin">org.apache.maven.plugin.AbstractMojo</a></li> -<li> -<ul class="inheritance"> -<li>org.apache.maven.plugins.jar.AbstractJarMojo</li> -</ul> -</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Implemented Interfaces:</dt> -<dd><a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/ContextEnabled.html?is-external=true"; title="class or interface in org.apache.maven.plugin">ContextEnabled</a>, <a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true"; title="class or interface in org.apache.maven.plugin">Mojo</a></dd> -</dl> -<dl> -<dt>Direct Known Subclasses:</dt> -<dd><a href="../../../../../org/apache/maven/plugins/jar/JarMojo.html" title="class in org.apache.maven.plugins.jar">JarMojo</a>, <a href="../../../../../org/apache/maven/plugins/jar/TestJarMojo.html" title="class in org.apache.maven.plugins.jar">TestJarMojo</a></dd> -</dl> -<hr> -<br> -<pre>public abstract class <span class="typeNameLabel">AbstractJarMojo</span> -extends <a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true"; title="class or interface in org.apache.maven.plugin">AbstractMojo</a></pre> -<div class="block">Base class for creating a jar from project classes.</div> -<dl> -<dt><span class="simpleTagLabel">Version:</span></dt> -<dd>$Id$</dd> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd><a href="[email protected]">Emmanuel Venisse</a></dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- =========== FIELD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="field.summary"> -<!-- --> -</a> -<h3>Field Summary</h3> -<ul class="blockList"> -<li class="blockList"><a name="fields.inherited.from.class.org.apache.maven.plugin.Mojo"> -<!-- --> -</a> -<h3>Fields inherited from interface org.apache.maven.plugin.<a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true"; title="class or interface in org.apache.maven.plugin">Mojo</a></h3> -<code><a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true#ROLE"; title="class or interface in org.apache.maven.plugin">ROLE</a></code></li> -</ul> -</li> -</ul> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#AbstractJarMojo--">AbstractJarMojo</a></span>()</code> </td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#createArchive--">createArchive</a></span>()</code> -<div class="block">Generates the JAR.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#execute--">execute</a></span>()</code> -<div class="block">Generates the JAR.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#getClassesDirectory--">getClassesDirectory</a></span>()</code> -<div class="block">Return the specific output directory to serve as the root for the archive.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#getClassifier--">getClassifier</a></span>()</code> -<div class="block">Overload this to produce a jar with another classifier, for example a test-jar.</div> -</td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#getJarFile-java.io.File-java.lang.String-java.lang.String-">getJarFile</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> basedir, - <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> resultFinalName, - <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> classifier)</code> -<div class="block">Returns the Jar file to generate, based on an optional classifier.</div> -</td> -</tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code>protected <a href="https://maven.apache.org/ref/3.1.0/maven-core/apidocs/org/apache/maven/project/MavenProject.html?is-external=true"; title="class or interface in org.apache.maven.project">MavenProject</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#getProject--">getProject</a></span>()</code> </td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#getType--">getType</a></span>()</code> -<div class="block">Overload this to produce a test-jar, for example.</div> -</td> -</tr> -<tr id="i7" class="rowColor"> -<td class="colFirst"><code>protected boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#hasClassifier--">hasClassifier</a></span>()</code> </td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo"> -<!-- --> -</a> -<h3>Methods inherited from class org.apache.maven.plugin.<a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true"; title="class or interface in org.apache.maven.plugin">AbstractMojo</a></h3> -<code><a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#getLog--"; title="class or interface in org.apache.maven.plugin">getLog</a>, <a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#getPluginContext--"; title="class or interface in org.apache.maven.plugin">getPluginContext</a>, <a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#setLog-org.apache.maven.plugin.logging.Log-"; title="class or interface in org.apache.maven.plugin">setLog</a>, <a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#setPluginContext-java.util.Map-"; title="class or interface in org.apache.maven.plugin">setPluginContext</a></code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> -<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="AbstractJarMojo--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>AbstractJarMojo</h4> -<pre>public AbstractJarMojo()</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getClassesDirectory--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getClassesDirectory</h4> -<pre>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> getClassesDirectory()</pre> -<div class="block">Return the specific output directory to serve as the root for the archive.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>get classes directory.</dd> -</dl> -</li> -</ul> -<a name="getProject--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getProject</h4> -<pre>protected final <a href="https://maven.apache.org/ref/3.1.0/maven-core/apidocs/org/apache/maven/project/MavenProject.html?is-external=true"; title="class or interface in org.apache.maven.project">MavenProject</a> getProject()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the <a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#project"><code>project</code></a></dd> -</dl> -</li> -</ul> -<a name="getClassifier--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getClassifier</h4> -<pre>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getClassifier()</pre> -<div class="block">Overload this to produce a jar with another classifier, for example a test-jar.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>get the classifier.</dd> -</dl> -</li> -</ul> -<a name="getType--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getType</h4> -<pre>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getType()</pre> -<div class="block">Overload this to produce a test-jar, for example.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>return the type.</dd> -</dl> -</li> -</ul> -<a name="getJarFile-java.io.File-java.lang.String-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getJarFile</h4> -<pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> getJarFile(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> basedir, - <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> resultFinalName, - <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> classifier)</pre> -<div class="block">Returns the Jar file to generate, based on an optional classifier.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>basedir</code> - the output directory</dd> -<dd><code>resultFinalName</code> - the name of the ear file</dd> -<dd><code>classifier</code> - an optional classifier</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the file to generate</dd> -</dl> -</li> -</ul> -<a name="createArchive--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>createArchive</h4> -<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> createArchive() - throws <a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoExecutionException.html?is-external=true"; title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></pre> -<div class="block">Generates the JAR.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The instance of File for the created archive file.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoExecutionException.html?is-external=true"; title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></code> - in case of an error.</dd> -</dl> -</li> -</ul> -<a name="execute--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>execute</h4> -<pre>public void execute() - throws <a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoExecutionException.html?is-external=true"; title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></pre> -<div class="block">Generates the JAR.</div> -<dl> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoExecutionException.html?is-external=true"; title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></code> - in case of an error.</dd> -</dl> -</li> -</ul> -<a name="hasClassifier--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>hasClassifier</h4> -<pre>protected boolean hasClassifier()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true in case where the classifier is not <code>null</code> and contains something else than white spaces.</dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../../org/apache/maven/plugins/jar/package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/AbstractJarMojo.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../../index-all.html">Index</a></li> -<li><a href="../../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../../org/apache/maven/plugins/jar/HelpMojo.html" title="class in org.apache.maven.plugins.jar"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../../index.html?org/apache/maven/plugins/jar/AbstractJarMojo.html" target="_top">Frames</a></li> -<li><a href="AbstractJarMojo.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2002–2022 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> -</body> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AbstractJarMojo (Apache Maven JAR Plugin 3.3.0 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="AbstractJarMojo (Apache Maven JAR Plugin 3.3.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":6,"i3":6,"i4":10,"i5":10,"i6":6,"i7":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../org/apache/maven/plugins/jar/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractJarMojo.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/maven/plugins/jar/HelpMojo.html" title="class in org.apache.maven.plugins.jar"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/maven/plugins/jar/AbstractJarMojo.html" target="_top">Frames</a></li> +<li><a href="AbstractJarMojo.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.maven.plugins.jar</div> +<h2 title="Class AbstractJarMojo" class="title">Class AbstractJarMojo</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.plugin.AbstractMojo</li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.plugins.jar.AbstractJarMojo</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/maven/plugins/jar/JarMojo.html" title="class in org.apache.maven.plugins.jar">JarMojo</a>, <a href="../../../../../org/apache/maven/plugins/jar/TestJarMojo.html" title="class in org.apache.maven.plugins.jar">TestJarMojo</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">AbstractJarMojo</span> +extends org.apache.maven.plugin.AbstractMojo</pre> +<div class="block">Base class for creating a jar from project classes.</div> +<dl> +<dt><span class="simpleTagLabel">Version:</span></dt> +<dd>$Id$</dd> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd><a href="[email protected]">Emmanuel Venisse</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.maven.plugin.Mojo"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.maven.plugin.Mojo</h3> +<code>ROLE</code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#AbstractJarMojo--">AbstractJarMojo</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#createArchive--">createArchive</a></span>()</code> +<div class="block">Generates the JAR.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#execute--">execute</a></span>()</code> +<div class="block">Generates the JAR.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#getClassesDirectory--">getClassesDirectory</a></span>()</code> +<div class="block">Return the specific output directory to serve as the root for the archive.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#getClassifier--">getClassifier</a></span>()</code> +<div class="block">Overload this to produce a jar with another classifier, for example a test-jar.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#getJarFile-java.io.File-java.lang.String-java.lang.String-">getJarFile</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> basedir, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> resultFinalName, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> classifier)</code> +<div class="block">Returns the Jar file to generate, based on an optional classifier.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>protected org.apache.maven.project.MavenProject</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#getProject--">getProject</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#getType--">getType</a></span>()</code> +<div class="block">Overload this to produce a test-jar, for example.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#hasClassifier--">hasClassifier</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3> +<code>getLog, getPluginContext, setLog, setPluginContext</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AbstractJarMojo--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractJarMojo</h4> +<pre>public AbstractJarMojo()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getClassesDirectory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClassesDirectory</h4> +<pre>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> getClassesDirectory()</pre> +<div class="block">Return the specific output directory to serve as the root for the archive.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>get classes directory.</dd> +</dl> +</li> +</ul> +<a name="getProject--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProject</h4> +<pre>protected final org.apache.maven.project.MavenProject getProject()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html#project"><code>project</code></a></dd> +</dl> +</li> +</ul> +<a name="getClassifier--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClassifier</h4> +<pre>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getClassifier()</pre> +<div class="block">Overload this to produce a jar with another classifier, for example a test-jar.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>get the classifier.</dd> +</dl> +</li> +</ul> +<a name="getType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getType()</pre> +<div class="block">Overload this to produce a test-jar, for example.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>return the type.</dd> +</dl> +</li> +</ul> +<a name="getJarFile-java.io.File-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJarFile</h4> +<pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> getJarFile(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> basedir, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> resultFinalName, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> classifier)</pre> +<div class="block">Returns the Jar file to generate, based on an optional classifier.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>basedir</code> - the output directory</dd> +<dd><code>resultFinalName</code> - the name of the ear file</dd> +<dd><code>classifier</code> - an optional classifier</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the file to generate</dd> +</dl> +</li> +</ul> +<a name="createArchive--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createArchive</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> createArchive() + throws org.apache.maven.plugin.MojoExecutionException</pre> +<div class="block">Generates the JAR.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The instance of File for the created archive file.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - in case of an error.</dd> +</dl> +</li> +</ul> +<a name="execute--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>public void execute() + throws org.apache.maven.plugin.MojoExecutionException</pre> +<div class="block">Generates the JAR.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - in case of an error.</dd> +</dl> +</li> +</ul> +<a name="hasClassifier--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hasClassifier</h4> +<pre>protected boolean hasClassifier()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true in case where the classifier is not <code>null</code> and contains something else than white spaces.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../org/apache/maven/plugins/jar/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractJarMojo.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/maven/plugins/jar/HelpMojo.html" title="class in org.apache.maven.plugins.jar"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/maven/plugins/jar/AbstractJarMojo.html" target="_top">Frames</a></li> +<li><a href="AbstractJarMojo.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2002–2022 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> </html> \ No newline at end of file
Modified: maven/website/components/plugins-archives/maven-jar-plugin-LATEST/apidocs/org/apache/maven/plugins/jar/HelpMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-jar-plugin-LATEST/apidocs/org/apache/maven/plugins/jar/HelpMojo.html (original) +++ maven/website/components/plugins-archives/maven-jar-plugin-LATEST/apidocs/org/apache/maven/plugins/jar/HelpMojo.html Mon Sep 12 16:00:29 2022 @@ -1,315 +1,315 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>HelpMojo (Apache Maven JAR Plugin 3.2.2 API)</title> -<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="HelpMojo (Apache Maven JAR Plugin 3.2.2 API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../../org/apache/maven/plugins/jar/package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/HelpMojo.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../../index-all.html">Index</a></li> -<li><a href="../../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html" title="class in org.apache.maven.plugins.jar"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/maven/plugins/jar/JarMojo.html" title="class in org.apache.maven.plugins.jar"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../../index.html?org/apache/maven/plugins/jar/HelpMojo.html" target="_top">Frames</a></li> -<li><a href="HelpMojo.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.maven.plugins.jar</div> -<h2 title="Class HelpMojo" class="title">Class HelpMojo</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> -<li> -<ul class="inheritance"> -<li><a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true"; title="class or interface in org.apache.maven.plugin">org.apache.maven.plugin.AbstractMojo</a></li> -<li> -<ul class="inheritance"> -<li>org.apache.maven.plugins.jar.HelpMojo</li> -</ul> -</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Implemented Interfaces:</dt> -<dd><a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/ContextEnabled.html?is-external=true"; title="class or interface in org.apache.maven.plugin">ContextEnabled</a>, <a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true"; title="class or interface in org.apache.maven.plugin">Mojo</a></dd> -</dl> -<hr> -<br> -<pre><a href="https://maven.apache.org/ref/3.1.0/maven-core/apidocs/org/apache/maven/plugins.annotations.Mojo.html?is-external=true"; title="class or interface in org.apache.maven">@Mojo</a>(name="help", - requiresProject=false, - threadSafe=true) -public class <span class="typeNameLabel">HelpMojo</span> -extends <a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true"; title="class or interface in org.apache.maven.plugin">AbstractMojo</a></pre> -<div class="block">Display help information on maven-jar-plugin.<br> - Call <code>mvn jar:help -Ddetail=true -Dgoal=<goal-name></code> to display parameter details.</div> -<dl> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>maven-plugin-tools</dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- =========== FIELD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="field.summary"> -<!-- --> -</a> -<h3>Field Summary</h3> -<ul class="blockList"> -<li class="blockList"><a name="fields.inherited.from.class.org.apache.maven.plugin.Mojo"> -<!-- --> -</a> -<h3>Fields inherited from interface org.apache.maven.plugin.<a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true"; title="class or interface in org.apache.maven.plugin">Mojo</a></h3> -<code><a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true#ROLE"; title="class or interface in org.apache.maven.plugin">ROLE</a></code></li> -</ul> -</li> -</ul> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/HelpMojo.html#HelpMojo--">HelpMojo</a></span>()</code> </td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/HelpMojo.html#execute--">execute</a></span>()</code></td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo"> -<!-- --> -</a> -<h3>Methods inherited from class org.apache.maven.plugin.<a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true"; title="class or interface in org.apache.maven.plugin">AbstractMojo</a></h3> -<code><a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#getLog--"; title="class or interface in org.apache.maven.plugin">getLog</a>, <a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#getPluginContext--"; title="class or interface in org.apache.maven.plugin">getPluginContext</a>, <a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#setLog-org.apache.maven.plugin.logging.Log-"; title="class or interface in org.apache.maven.plugin">setLog</a>, <a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#setPluginContext-java.util.Map-"; title="class or interface in org.apache.maven.plugin">setPluginContext</a></code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> -<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="HelpMojo--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>HelpMojo</h4> -<pre>public HelpMojo()</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="execute--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>execute</h4> -<pre>public void execute() - throws <a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoExecutionException.html?is-external=true"; title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></pre> -<dl> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="https://maven.apache.org/ref/3.1.0/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoExecutionException.html?is-external=true"; title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></code></dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../../org/apache/maven/plugins/jar/package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/HelpMojo.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../../index-all.html">Index</a></li> -<li><a href="../../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html" title="class in org.apache.maven.plugins.jar"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/maven/plugins/jar/JarMojo.html" title="class in org.apache.maven.plugins.jar"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../../index.html?org/apache/maven/plugins/jar/HelpMojo.html" target="_top">Frames</a></li> -<li><a href="HelpMojo.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2002–2022 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> -</body> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>HelpMojo (Apache Maven JAR Plugin 3.3.0 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="HelpMojo (Apache Maven JAR Plugin 3.3.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../org/apache/maven/plugins/jar/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/HelpMojo.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html" title="class in org.apache.maven.plugins.jar"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/maven/plugins/jar/JarMojo.html" title="class in org.apache.maven.plugins.jar"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/maven/plugins/jar/HelpMojo.html" target="_top">Frames</a></li> +<li><a href="HelpMojo.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.maven.plugins.jar</div> +<h2 title="Class HelpMojo" class="title">Class HelpMojo</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.plugin.AbstractMojo</li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.plugins.jar.HelpMojo</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo</dd> +</dl> +<hr> +<br> +<pre>@Mojo(name="help", + requiresProject=false, + threadSafe=true) +public class <span class="typeNameLabel">HelpMojo</span> +extends org.apache.maven.plugin.AbstractMojo</pre> +<div class="block">Display help information on maven-jar-plugin.<br> + Call <code>mvn jar:help -Ddetail=true -Dgoal=<goal-name></code> to display parameter details.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>maven-plugin-tools</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.maven.plugin.Mojo"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.maven.plugin.Mojo</h3> +<code>ROLE</code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/HelpMojo.html#HelpMojo--">HelpMojo</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/jar/HelpMojo.html#execute--">execute</a></span>()</code></td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3> +<code>getLog, getPluginContext, setLog, setPluginContext</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="HelpMojo--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HelpMojo</h4> +<pre>public HelpMojo()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="execute--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>execute</h4> +<pre>public void execute() + throws org.apache.maven.plugin.MojoExecutionException</pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../org/apache/maven/plugins/jar/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/HelpMojo.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/maven/plugins/jar/AbstractJarMojo.html" title="class in org.apache.maven.plugins.jar"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/maven/plugins/jar/JarMojo.html" title="class in org.apache.maven.plugins.jar"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/maven/plugins/jar/HelpMojo.html" target="_top">Frames</a></li> +<li><a href="HelpMojo.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2002–2022 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> </html> \ No newline at end of file
