Modified: maven/website/components/shared-archives/maven-archiver-LATEST/apidocs/org/apache/maven/archiver/ManifestConfiguration.html ============================================================================== --- maven/website/components/shared-archives/maven-archiver-LATEST/apidocs/org/apache/maven/archiver/ManifestConfiguration.html (original) +++ maven/website/components/shared-archives/maven-archiver-LATEST/apidocs/org/apache/maven/archiver/ManifestConfiguration.html Tue Oct 22 15:29:46 2024 @@ -1,680 +1,874 @@ -<!DOCTYPE HTML> -<html lang="en"> -<head> -<!-- Generated by javadoc (21) --> -<title>ManifestConfiguration (Apache Maven Archiver 4.0.0-beta-1 API)</title> -<meta name="viewport" content="width=device-width, initial-scale=1"> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<meta name="description" content="declaration: package: org.apache.maven.archiver, class: ManifestConfiguration"> -<meta name="generator" content="javadoc/ClassWriterImpl"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> -<script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script> -<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> -</head> -<body class="class-declaration-page"> -<script type="text/javascript">var pathtoroot = "../../../../"; -loadScripts(document, 'script');</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<div class="flex-box"> -<header role="banner" class="flex-header"> -<nav role="navigation"> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> -<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> -<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> -<li><a href="package-summary.html">Package</a></li> -<li class="nav-bar-cell1-rev">Class</li> -<li><a href="class-use/ManifestConfiguration.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html#class">Help</a></li> -</ul> -<ul class="sub-nav-list-small"> -<li> -<p>Summary:</p> -<ul> -<li>Nested</li> -<li><a href="#field-summary">Field</a></li> -<li><a href="#constructor-summary">Constr</a></li> -<li><a href="#method-summary">Method</a></li> -</ul> -</li> -<li> -<p>Detail:</p> -<ul> -<li><a href="#field-detail">Field</a></li> -<li><a href="#constructor-detail">Constr</a></li> -<li><a href="#method-detail">Method</a></li> -</ul> -</li> -</ul> -</div> -<div class="sub-nav"> -<div id="navbar-sub-list"> -<ul class="sub-nav-list"> -<li>Summary: </li> -<li>Nested | </li> -<li><a href="#field-summary">Field</a> | </li> -<li><a href="#constructor-summary">Constr</a> | </li> -<li><a href="#method-summary">Method</a></li> -</ul> -<ul class="sub-nav-list"> -<li>Detail: </li> -<li><a href="#field-detail">Field</a> | </li> -<li><a href="#constructor-detail">Constr</a> | </li> -<li><a href="#method-detail">Method</a></li> -</ul> -</div> -<div class="nav-list-search"><a href="../../../../search.html">SEARCH</a> -<input type="text" id="search-input" disabled placeholder="Search"> -<input type="reset" id="reset-button" disabled value="reset"> -</div> -</div> -<!-- ========= END OF TOP NAVBAR ========= --> -<span class="skip-nav" id="skip-navbar-top"></span></nav> -</header> -<div class="flex-content"> -<main role="main"> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.maven.archiver</a></div> -<h1 title="Class ManifestConfiguration" class="title">Class ManifestConfiguration</h1> -</div> -<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> -<div class="inheritance">org.apache.maven.archiver.ManifestConfiguration</div> -</div> -<section class="class-description" id="class-description"> -<hr> -<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ManifestConfiguration</span> -<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> -<div class="block">Capture common manifest configuration.</div> -</section> -<section class="summary"> -<ul class="summary-list"> -<!-- =========== FIELD SUMMARY =========== --> -<li> -<section class="field-summary" id="field-summary"> -<h2>Field Summary</h2> -<div class="caption"><span>Fields</span></div> -<div class="summary-table three-column-summary"> -<div class="table-header col-first">Modifier and Type</div> -<div class="table-header col-second">Field</div> -<div class="table-header col-last">Description</div> -<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> -<div class="col-second even-row-color"><code><a href="#CLASSPATH_LAYOUT_TYPE_CUSTOM" class="member-name-link">CLASSPATH_LAYOUT_TYPE_CUSTOM</a></code></div> -<div class="col-last even-row-color"> -<div class="block">custom layout type.</div> -</div> -<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> -<div class="col-second odd-row-color"><code><a href="#CLASSPATH_LAYOUT_TYPE_REPOSITORY" class="member-name-link">CLASSPATH_LAYOUT_TYPE_REPOSITORY</a></code></div> -<div class="col-last odd-row-color"> -<div class="block">The layout type</div> -</div> -<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> -<div class="col-second even-row-color"><code><a href="#CLASSPATH_LAYOUT_TYPE_SIMPLE" class="member-name-link">CLASSPATH_LAYOUT_TYPE_SIMPLE</a></code></div> -<div class="col-last even-row-color"> -<div class="block">The simple layout.</div> -</div> -</div> -</section> -</li> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<li> -<section class="constructor-summary" id="constructor-summary"> -<h2>Constructor Summary</h2> -<div class="caption"><span>Constructors</span></div> -<div class="summary-table two-column-summary"> -<div class="table-header col-first">Constructor</div> -<div class="table-header col-last">Description</div> -<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ManifestConfiguration</a>()</code></div> -<div class="col-last even-row-color"> </div> -</div> -</section> -</li> -<!-- ========== METHOD SUMMARY =========== --> -<li> -<section class="method-summary" id="method-summary"> -<h2>Method Summary</h2> -<div id="method-summary-table"> -<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> -<div id="method-summary-table.tabpanel" role="tabpanel"> -<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> -<div class="table-header col-first">Modifier and Type</div> -<div class="table-header col-second">Method</div> -<div class="table-header col-last">Description</div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClasspathLayoutType()" class="member-name-link">getClasspathLayoutType</a>()</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Return the type of layout to use when formatting classpath entries.</div> -</div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClasspathPrefix()" class="member-name-link">getClasspathPrefix</a>()</code></div> -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Getter for the field <code>classpathPrefix</code>.</div> -</div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCustomClasspathLayout()" class="member-name-link">getCustomClasspathLayout</a>()</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Retrieve the layout expression for use when the layout type set in - <a href="#setClasspathLayoutType(java.lang.String)"><code>setClasspathLayoutType(String)</code></a> has the value 'custom'.</div> -</div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMainClass()" class="member-name-link">getMainClass</a>()</code></div> -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Getter for the field <code>mainClass</code>.</div> -</div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPackageName()" class="member-name-link">getPackageName</a>()</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Getter for the field <code>packageName</code>.</div> -</div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAddBuildEnvironmentEntries()" class="member-name-link">isAddBuildEnvironmentEntries</a>()</code></div> -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">isAddBuildEnvironmentEntries.</div> -</div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAddClasspath()" class="member-name-link">isAddClasspath</a>()</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">isAddClasspath.</div> -</div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAddDefaultEntries()" class="member-name-link">isAddDefaultEntries</a>()</code></div> -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">isAddDefaultEntries.</div> -</div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAddDefaultImplementationEntries()" class="member-name-link">isAddDefaultImplementationEntries</a>()</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">isAddDefaultImplementationEntries.</div> -</div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAddDefaultSpecificationEntries()" class="member-name-link">isAddDefaultSpecificationEntries</a>()</code></div> -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">isAddDefaultSpecificationEntries.</div> -</div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAddExtensions()" class="member-name-link">isAddExtensions</a>()</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">isAddExtensions.</div> -</div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isUseUniqueVersions()" class="member-name-link">isUseUniqueVersions</a>()</code></div> -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Retrieve the flag for whether snapshot artifacts should be added to the classpath using the - timestamp/buildnumber version (the default, when this flag is true), or using the generic - -SNAPSHOT version (when the flag is false).</div> -</div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAddBuildEnvironmentEntries(boolean)" class="member-name-link">setAddBuildEnvironmentEntries</a><wbr>(boolean addBuildEnvironmentEntries)</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Setter for the field <code>addBuildEnvironmentEntries</code>.</div> -</div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAddClasspath(boolean)" class="member-name-link">setAddClasspath</a><wbr>(boolean addClasspath)</code></div> -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Setter for the field <code>addClasspath</code>.</div> -</div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAddDefaultEntries(boolean)" class="member-name-link">setAddDefaultEntries</a><wbr>(boolean addDefaultEntries)</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Setter for the field <code>addDefaultEntries</code>.</div> -</div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAddDefaultImplementationEntries(boolean)" class="member-name-link">setAddDefaultImplementationEntries</a><wbr>(boolean addDefaultImplementationEntries)</code></div> -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Setter for the field <code>addDefaultImplementationEntries</code>.</div> -</div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAddDefaultSpecificationEntries(boolean)" class="member-name-link">setAddDefaultSpecificationEntries</a><wbr>(boolean addDefaultSpecificationEntries)</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Setter for the field <code>addDefaultSpecificationEntries</code>.</div> -</div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAddExtensions(boolean)" class="member-name-link">setAddExtensions</a><wbr>(boolean addExtensions)</code></div> -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Setter for the field <code>addExtensions</code>.</div> -</div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setClasspathLayoutType(java.lang.String)" class="member-name-link">setClasspathLayoutType</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> classpathLayoutType)</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Set the type of layout to use when formatting classpath entries.</div> -</div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setClasspathPrefix(java.lang.String)" class="member-name-link">setClasspathPrefix</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> classpathPrefix)</code></div> -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Setter for the field <code>classpathPrefix</code>.</div> -</div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCustomClasspathLayout(java.lang.String)" class="member-name-link">setCustomClasspathLayout</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> customClasspathLayout)</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Set the layout expression for use when the layout type set in - <a href="#setClasspathLayoutType(java.lang.String)"><code>setClasspathLayoutType(String)</code></a> has the value 'custom'.</div> -</div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMainClass(java.lang.String)" class="member-name-link">setMainClass</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> mainClass)</code></div> -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Setter for the field <code>mainClass</code>.</div> -</div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPackageName(java.lang.String)" class="member-name-link">setPackageName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> packageName)</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Setter for the field <code>packageName</code>.</div> -</div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setUseUniqueVersions(boolean)" class="member-name-link">setUseUniqueVersions</a><wbr>(boolean useUniqueVersions)</code></div> -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Set the flag for whether snapshot artifacts should be added to the classpath using the timestamp/buildnumber - version (the default, when this flag is true), or using the generic -SNAPSHOT version (when the flag is false).</div> -</div> -</div> -</div> -</div> -<div class="inherited-list"> -<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> -<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Objec t.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> -</section> -</li> -</ul> -</section> -<section class="details"> -<ul class="details-list"> -<!-- ============ FIELD DETAIL =========== --> -<li> -<section class="field-details" id="field-detail"> -<h2>Field Details</h2> -<ul class="member-list"> -<li> -<section class="detail" id="CLASSPATH_LAYOUT_TYPE_SIMPLE"> -<h3>CLASSPATH_LAYOUT_TYPE_SIMPLE</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">CLASSPATH_LAYOUT_TYPE_SIMPLE</span></div> -<div class="block">The simple layout.</div> -<dl class="notes"> -<dt>See Also:</dt> -<dd> -<ul class="tag-list"> -<li><a href="../../../../constant-values.html#org.apache.maven.archiver.ManifestConfiguration.CLASSPATH_LAYOUT_TYPE_SIMPLE">Constant Field Values</a></li> -</ul> -</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="CLASSPATH_LAYOUT_TYPE_REPOSITORY"> -<h3>CLASSPATH_LAYOUT_TYPE_REPOSITORY</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">CLASSPATH_LAYOUT_TYPE_REPOSITORY</span></div> -<div class="block">The layout type</div> -<dl class="notes"> -<dt>See Also:</dt> -<dd> -<ul class="tag-list"> -<li><a href="../../../../constant-values.html#org.apache.maven.archiver.ManifestConfiguration.CLASSPATH_LAYOUT_TYPE_REPOSITORY">Constant Field Values</a></li> -</ul> -</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="CLASSPATH_LAYOUT_TYPE_CUSTOM"> -<h3>CLASSPATH_LAYOUT_TYPE_CUSTOM</h3> -<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">CLASSPATH_LAYOUT_TYPE_CUSTOM</span></div> -<div class="block">custom layout type.</div> -<dl class="notes"> -<dt>See Also:</dt> -<dd> -<ul class="tag-list"> -<li><a href="../../../../constant-values.html#org.apache.maven.archiver.ManifestConfiguration.CLASSPATH_LAYOUT_TYPE_CUSTOM">Constant Field Values</a></li> -</ul> -</dd> -</dl> -</section> -</li> -</ul> -</section> -</li> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<li> -<section class="constructor-details" id="constructor-detail"> -<h2>Constructor Details</h2> -<ul class="member-list"> -<li> -<section class="detail" id="<init>()"> -<h3>ManifestConfiguration</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ManifestConfiguration</span>()</div> -</section> -</li> -</ul> -</section> -</li> -<!-- ============ METHOD DETAIL ========== --> -<li> -<section class="method-details" id="method-detail"> -<h2>Method Details</h2> -<ul class="member-list"> -<li> -<section class="detail" id="getMainClass()"> -<h3>getMainClass</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getMainClass</span>()</div> -<div class="block"><p>Getter for the field <code>mainClass</code>.</p></div> -<dl class="notes"> -<dt>Returns:</dt> -<dd>mainClass</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="getPackageName()"> -<h3>getPackageName</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getPackageName</span>()</div> -<div class="block"><p>Getter for the field <code>packageName</code>.</p></div> -<dl class="notes"> -<dt>Returns:</dt> -<dd>the package name.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="isAddClasspath()"> -<h3>isAddClasspath</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isAddClasspath</span>()</div> -<div class="block"><p>isAddClasspath.</p></div> -<dl class="notes"> -<dt>Returns:</dt> -<dd>if addClasspath true or false.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="isAddDefaultEntries()"> -<h3>isAddDefaultEntries</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isAddDefaultEntries</span>()</div> -<div class="block"><p>isAddDefaultEntries.</p></div> -<dl class="notes"> -<dt>Returns:</dt> -<dd><code>addDefaultEntries</code></dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="isAddBuildEnvironmentEntries()"> -<h3>isAddBuildEnvironmentEntries</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isAddBuildEnvironmentEntries</span>()</div> -<div class="block"><p>isAddBuildEnvironmentEntries.</p></div> -<dl class="notes"> -<dt>Returns:</dt> -<dd><code>addBuildEnvironmentEntries</code></dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="isAddDefaultImplementationEntries()"> -<h3>isAddDefaultImplementationEntries</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isAddDefaultImplementationEntries</span>()</div> -<div class="block"><p>isAddDefaultImplementationEntries.</p></div> -<dl class="notes"> -<dt>Returns:</dt> -<dd><code>addDefaultImplementationEntries</code></dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="isAddDefaultSpecificationEntries()"> -<h3>isAddDefaultSpecificationEntries</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isAddDefaultSpecificationEntries</span>()</div> -<div class="block"><p>isAddDefaultSpecificationEntries.</p></div> -<dl class="notes"> -<dt>Returns:</dt> -<dd><code>addDefaultSpecificationEntries</code></dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="isAddExtensions()"> -<h3>isAddExtensions</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isAddExtensions</span>()</div> -<div class="block"><p>isAddExtensions.</p></div> -<dl class="notes"> -<dt>Returns:</dt> -<dd><code>addExtensions</code></dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="setAddClasspath(boolean)"> -<h3>setAddClasspath</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAddClasspath</span><wbr><span class="parameters">(boolean addClasspath)</span></div> -<div class="block"><p>Setter for the field <code>addClasspath</code>.</p></div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>addClasspath</code> - turn on addClasspath or off.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="setAddDefaultEntries(boolean)"> -<h3>setAddDefaultEntries</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAddDefaultEntries</span><wbr><span class="parameters">(boolean addDefaultEntries)</span></div> -<div class="block"><p>Setter for the field <code>addDefaultEntries</code>.</p></div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>addDefaultEntries</code> - add default entries true/false.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="setAddBuildEnvironmentEntries(boolean)"> -<h3>setAddBuildEnvironmentEntries</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAddBuildEnvironmentEntries</span><wbr><span class="parameters">(boolean addBuildEnvironmentEntries)</span></div> -<div class="block"><p>Setter for the field <code>addBuildEnvironmentEntries</code>.</p></div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>addBuildEnvironmentEntries</code> - add build environment information true/false.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="setAddDefaultImplementationEntries(boolean)"> -<h3>setAddDefaultImplementationEntries</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAddDefaultImplementationEntries</span><wbr><span class="parameters">(boolean addDefaultImplementationEntries)</span></div> -<div class="block"><p>Setter for the field <code>addDefaultImplementationEntries</code>.</p></div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>addDefaultImplementationEntries</code> - true to add default implementations false otherwise.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="setAddDefaultSpecificationEntries(boolean)"> -<h3>setAddDefaultSpecificationEntries</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAddDefaultSpecificationEntries</span><wbr><span class="parameters">(boolean addDefaultSpecificationEntries)</span></div> -<div class="block"><p>Setter for the field <code>addDefaultSpecificationEntries</code>.</p></div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>addDefaultSpecificationEntries</code> - add default specifications true/false.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="setAddExtensions(boolean)"> -<h3>setAddExtensions</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAddExtensions</span><wbr><span class="parameters">(boolean addExtensions)</span></div> -<div class="block"><p>Setter for the field <code>addExtensions</code>.</p></div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>addExtensions</code> - true to add extensions false otherwise.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="setClasspathPrefix(java.lang.String)"> -<h3>setClasspathPrefix</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setClasspathPrefix</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> classpathPrefix)</span></div> -<div class="block"><p>Setter for the field <code>classpathPrefix</code>.</p></div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>classpathPrefix</code> - The prefix.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="setMainClass(java.lang.String)"> -<h3>setMainClass</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMainClass</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> mainClass)</span></div> -<div class="block"><p>Setter for the field <code>mainClass</code>.</p></div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>mainClass</code> - The main class.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="setPackageName(java.lang.String)"> -<h3>setPackageName</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setPackageName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> packageName)</span></div> -<div class="block"><p>Setter for the field <code>packageName</code>.</p></div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>packageName</code> - The package name.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="getClasspathPrefix()"> -<h3>getClasspathPrefix</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getClasspathPrefix</span>()</div> -<div class="block"><p>Getter for the field <code>classpathPrefix</code>.</p></div> -<dl class="notes"> -<dt>Returns:</dt> -<dd>The classpath prefix.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="getClasspathLayoutType()"> -<h3>getClasspathLayoutType</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getClasspathLayoutType</span>()</div> -<div class="block">Return the type of layout to use when formatting classpath entries. Default is taken from the constant - CLASSPATH_LAYOUT_TYPE_SIMPLE, declared in this class, which has a value of 'simple'. Other values are: - 'repository' (CLASSPATH_LAYOUT_TYPE_REPOSITORY, or the same as a maven classpath layout), and 'custom' - (CLASSPATH_LAYOUT_TYPE_CUSTOM). <br> - <b>NOTE:</b> If you specify a type of 'custom' you MUST set - <a href="#setCustomClasspathLayout(java.lang.String)"><code>setCustomClasspathLayout(String)</code></a>.</div> -<dl class="notes"> -<dt>Returns:</dt> -<dd>The classpath layout type.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="setClasspathLayoutType(java.lang.String)"> -<h3>setClasspathLayoutType</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setClasspathLayoutType</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> classpathLayoutType)</span></div> -<div class="block">Set the type of layout to use when formatting classpath entries. Should be one of: 'simple' - (CLASSPATH_LAYOUT_TYPE_SIMPLE), 'repository' (CLASSPATH_LAYOUT_TYPE_REPOSITORY, or the same as a maven classpath - layout), and 'custom' (CLASSPATH_LAYOUT_TYPE_CUSTOM). The constant names noted here are defined in the - <a href="ManifestConfiguration.html" title="class in org.apache.maven.archiver"><code>ManifestConfiguration</code></a> class. <br> - <b>NOTE:</b> If you specify a type of 'custom' you MUST set - <a href="#setCustomClasspathLayout(java.lang.String)"><code>setCustomClasspathLayout(String)</code></a>.</div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>classpathLayoutType</code> - The classpath layout type.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="getCustomClasspathLayout()"> -<h3>getCustomClasspathLayout</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getCustomClasspathLayout</span>()</div> -<div class="block">Retrieve the layout expression for use when the layout type set in - <a href="#setClasspathLayoutType(java.lang.String)"><code>setClasspathLayoutType(String)</code></a> has the value 'custom'. - <b>The default value is - null.</b> Expressions will be evaluated against the following ordered list of classpath-related objects: - <ol> - <li>The current <code>Artifact</code> instance, if one exists.</li> - <li>The current <code>ArtifactHandler</code> instance from the artifact above.</li> - </ol> - <br> - <b>NOTE:</b> If you specify a layout type of 'custom' you MUST set this layout expression.</div> -<dl class="notes"> -<dt>Returns:</dt> -<dd>The custom classpath layout.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="setCustomClasspathLayout(java.lang.String)"> -<h3>setCustomClasspathLayout</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setCustomClasspathLayout</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> customClasspathLayout)</span></div> -<div class="block">Set the layout expression for use when the layout type set in - <a href="#setClasspathLayoutType(java.lang.String)"><code>setClasspathLayoutType(String)</code></a> has the value 'custom'. - Expressions will be - evaluated against the following ordered list of classpath-related objects: - <ol> - <li>The current <code>Artifact</code> instance, if one exists.</li> - <li>The current <code>ArtifactHandler</code> instance from the artifact above.</li> - </ol> - <br> - <b>NOTE:</b> If you specify a layout type of 'custom' you MUST set this layout expression. - You can take a look at - <ol> - <li><a href="MavenArchiver.html#SIMPLE_LAYOUT"><code>MavenArchiver.SIMPLE_LAYOUT</code></a></li> - <li><a href="MavenArchiver.html#SIMPLE_LAYOUT_NONUNIQUE"><code>MavenArchiver.SIMPLE_LAYOUT_NONUNIQUE</code></a></li> - <li><a href="MavenArchiver.html#REPOSITORY_LAYOUT"><code>MavenArchiver.REPOSITORY_LAYOUT</code></a></li> - <li><a href="MavenArchiver.html#REPOSITORY_LAYOUT_NONUNIQUE"><code>MavenArchiver.REPOSITORY_LAYOUT_NONUNIQUE</code></a></li> - </ol> - how such an expression looks like.</div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>customClasspathLayout</code> - The custom classpath layout.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="isUseUniqueVersions()"> -<h3>isUseUniqueVersions</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isUseUniqueVersions</span>()</div> -<div class="block">Retrieve the flag for whether snapshot artifacts should be added to the classpath using the - timestamp/buildnumber version (the default, when this flag is true), or using the generic - -SNAPSHOT version (when the flag is false). <br> - <b>NOTE:</b> If the snapshot was installed locally, this flag will not have an effect on - that artifact's inclusion, since it will have the same version either way (i.e. -SNAPSHOT naming).</div> -<dl class="notes"> -<dt>Returns:</dt> -<dd>The state of <code>useUniqueVersions</code></dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="setUseUniqueVersions(boolean)"> -<h3>setUseUniqueVersions</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setUseUniqueVersions</span><wbr><span class="parameters">(boolean useUniqueVersions)</span></div> -<div class="block">Set the flag for whether snapshot artifacts should be added to the classpath using the timestamp/buildnumber - version (the default, when this flag is true), or using the generic -SNAPSHOT version (when the flag is false). - <br> - <b>NOTE:</b> If the snapshot was installed locally, this flag will not have an effect on that artifact's - inclusion, since it will have the same version either way (i.e. -SNAPSHOT naming).</div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>useUniqueVersions</code> - true to use unique versions or not.</dd> -</dl> -</section> -</li> -</ul> -</section> -</li> -</ul> -</section> -<!-- ========= END OF CLASS DATA ========= --> -</main> -<footer role="contentinfo"> -<hr> -<p class="legal-copy"><small>Copyright © 2002–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> -</footer> -</div> -</div> -</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>ManifestConfiguration (Apache Maven Archiver 3.6.3 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="ManifestConfiguration (Apache Maven Archiver 3.6.3 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":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/archiver/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ManifestConfiguration.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/archiver/ManifestSection.html" title="class in org.apache.maven.archiver"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/maven/archiver/ManifestConfiguration.html" target="_top">Frames</a></li> +<li><a href="ManifestConfiguration.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.archiver</div> +<h2 title="Class ManifestConfiguration" class="title">Class ManifestConfiguration</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.archiver.ManifestConfiguration</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ManifestConfiguration</span> +extends <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></pre> +<div class="block">Capture common manifest configuration.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd><a href="mailto:[email protected]">Brett Porter</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> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <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/archiver/ManifestConfiguration.html#CLASSPATH_LAYOUT_TYPE_CUSTOM">CLASSPATH_LAYOUT_TYPE_CUSTOM</a></span></code> +<div class="block">custom layout type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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/archiver/ManifestConfiguration.html#CLASSPATH_LAYOUT_TYPE_REPOSITORY">CLASSPATH_LAYOUT_TYPE_REPOSITORY</a></span></code> +<div class="block">The layout type</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <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/archiver/ManifestConfiguration.html#CLASSPATH_LAYOUT_TYPE_SIMPLE">CLASSPATH_LAYOUT_TYPE_SIMPLE</a></span></code> +<div class="block">The simple layout.</div> +</td> +</tr> +</table> +</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/archiver/ManifestConfiguration.html#ManifestConfiguration--">ManifestConfiguration</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><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/archiver/ManifestConfiguration.html#getClasspathLayoutType--">getClasspathLayoutType</a></span>()</code> +<div class="block">Return the type of layout to use when formatting classpath entries.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><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/archiver/ManifestConfiguration.html#getClasspathPrefix--">getClasspathPrefix</a></span>()</code> +<div class="block">Getter for the field <code>classpathPrefix</code>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><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/archiver/ManifestConfiguration.html#getCustomClasspathLayout--">getCustomClasspathLayout</a></span>()</code> +<div class="block">Retrieve the layout expression for use when the layout type set in + <a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setClasspathLayoutType-java.lang.String-"><code>setClasspathLayoutType(String)</code></a> has the value 'custom'.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><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/archiver/ManifestConfiguration.html#getMainClass--">getMainClass</a></span>()</code> +<div class="block">Getter for the field <code>mainClass</code>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><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/archiver/ManifestConfiguration.html#getPackageName--">getPackageName</a></span>()</code> +<div class="block">Getter for the field <code>packageName</code>.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#isAddBuildEnvironmentEntries--">isAddBuildEnvironmentEntries</a></span>()</code> +<div class="block">isAddBuildEnvironmentEntries.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#isAddClasspath--">isAddClasspath</a></span>()</code> +<div class="block">isAddClasspath.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#isAddDefaultEntries--">isAddDefaultEntries</a></span>()</code> +<div class="block">isAddDefaultEntries.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#isAddDefaultImplementationEntries--">isAddDefaultImplementationEntries</a></span>()</code> +<div class="block">isAddDefaultImplementationEntries.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#isAddDefaultSpecificationEntries--">isAddDefaultSpecificationEntries</a></span>()</code> +<div class="block">isAddDefaultSpecificationEntries.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#isAddExtensions--">isAddExtensions</a></span>()</code> +<div class="block">isAddExtensions.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#isUseUniqueVersions--">isUseUniqueVersions</a></span>()</code> +<div class="block">Retrieve the flag for whether snapshot artifacts should be added to the classpath using the + timestamp/buildnumber version (the default, when this flag is true), or using the generic + -SNAPSHOT version (when the flag is false).</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setAddBuildEnvironmentEntries-boolean-">setAddBuildEnvironmentEntries</a></span>(boolean addBuildEnvironmentEntries)</code> +<div class="block">Setter for the field <code>addBuildEnvironmentEntries</code>.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setAddClasspath-boolean-">setAddClasspath</a></span>(boolean addClasspath)</code> +<div class="block">Setter for the field <code>addClasspath</code>.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setAddDefaultEntries-boolean-">setAddDefaultEntries</a></span>(boolean addDefaultEntries)</code> +<div class="block">Setter for the field <code>addDefaultEntries</code>.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setAddDefaultImplementationEntries-boolean-">setAddDefaultImplementationEntries</a></span>(boolean addDefaultImplementationEntries)</code> +<div class="block">Setter for the field <code>addDefaultImplementationEntries</code>.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setAddDefaultSpecificationEntries-boolean-">setAddDefaultSpecificationEntries</a></span>(boolean addDefaultSpecificationEntries)</code> +<div class="block">Setter for the field <code>addDefaultSpecificationEntries</code>.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setAddExtensions-boolean-">setAddExtensions</a></span>(boolean addExtensions)</code> +<div class="block">Setter for the field <code>addExtensions</code>.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setClasspathLayoutType-java.lang.String-">setClasspathLayoutType</a></span>(<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> classpathLayoutType)</code> +<div class="block">Set the type of layout to use when formatting classpath entries.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setClasspathPrefix-java.lang.String-">setClasspathPrefix</a></span>(<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> classpathPrefix)</code> +<div class="block">Setter for the field <code>classpathPrefix</code>.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setCustomClasspathLayout-java.lang.String-">setCustomClasspathLayout</a></span>(<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> customClasspathLayout)</code> +<div class="block">Set the layout expression for use when the layout type set in + <a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setClasspathLayoutType-java.lang.String-"><code>setClasspathLayoutType(String)</code></a> has the value 'custom'.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setMainClass-java.lang.String-">setMainClass</a></span>(<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> mainClass)</code> +<div class="block">Setter for the field <code>mainClass</code>.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setPackageName-java.lang.String-">setPackageName</a></span>(<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> packageName)</code> +<div class="block">Setter for the field <code>packageName</code>.</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setUseUniqueVersions-boolean-">setUseUniqueVersions</a></span>(boolean useUniqueVersions)</code> +<div class="block">Set the flag for whether snapshot artifacts should be added to the classpath using the timestamp/buildnumber + version (the default, when this flag is true), or using the generic -SNAPSHOT version (when the flag is false).</div> +</td> +</tr> +</table> +<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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="CLASSPATH_LAYOUT_TYPE_SIMPLE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CLASSPATH_LAYOUT_TYPE_SIMPLE</h4> +<pre>public static final <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> CLASSPATH_LAYOUT_TYPE_SIMPLE</pre> +<div class="block">The simple layout.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.maven.archiver.ManifestConfiguration.CLASSPATH_LAYOUT_TYPE_SIMPLE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="CLASSPATH_LAYOUT_TYPE_REPOSITORY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CLASSPATH_LAYOUT_TYPE_REPOSITORY</h4> +<pre>public static final <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> CLASSPATH_LAYOUT_TYPE_REPOSITORY</pre> +<div class="block">The layout type</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.maven.archiver.ManifestConfiguration.CLASSPATH_LAYOUT_TYPE_REPOSITORY">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="CLASSPATH_LAYOUT_TYPE_CUSTOM"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CLASSPATH_LAYOUT_TYPE_CUSTOM</h4> +<pre>public static final <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> CLASSPATH_LAYOUT_TYPE_CUSTOM</pre> +<div class="block">custom layout type.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.maven.archiver.ManifestConfiguration.CLASSPATH_LAYOUT_TYPE_CUSTOM">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ManifestConfiguration--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ManifestConfiguration</h4> +<pre>public ManifestConfiguration()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getMainClass--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMainClass</h4> +<pre>public <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> getMainClass()</pre> +<div class="block"><p>Getter for the field <code>mainClass</code>.</p></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>mainClass</dd> +</dl> +</li> +</ul> +<a name="getPackageName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPackageName</h4> +<pre>public <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> getPackageName()</pre> +<div class="block"><p>Getter for the field <code>packageName</code>.</p></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the package name.</dd> +</dl> +</li> +</ul> +<a name="isAddClasspath--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAddClasspath</h4> +<pre>public boolean isAddClasspath()</pre> +<div class="block"><p>isAddClasspath.</p></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>if addClasspath true or false.</dd> +</dl> +</li> +</ul> +<a name="isAddDefaultEntries--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAddDefaultEntries</h4> +<pre>public boolean isAddDefaultEntries()</pre> +<div class="block"><p>isAddDefaultEntries.</p></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#addDefaultEntries"><code>addDefaultEntries</code></a></dd> +</dl> +</li> +</ul> +<a name="isAddBuildEnvironmentEntries--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAddBuildEnvironmentEntries</h4> +<pre>public boolean isAddBuildEnvironmentEntries()</pre> +<div class="block"><p>isAddBuildEnvironmentEntries.</p></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#addBuildEnvironmentEntries"><code>addBuildEnvironmentEntries</code></a></dd> +</dl> +</li> +</ul> +<a name="isAddDefaultImplementationEntries--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAddDefaultImplementationEntries</h4> +<pre>public boolean isAddDefaultImplementationEntries()</pre> +<div class="block"><p>isAddDefaultImplementationEntries.</p></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#addDefaultImplementationEntries"><code>addDefaultImplementationEntries</code></a></dd> +</dl> +</li> +</ul> +<a name="isAddDefaultSpecificationEntries--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAddDefaultSpecificationEntries</h4> +<pre>public boolean isAddDefaultSpecificationEntries()</pre> +<div class="block"><p>isAddDefaultSpecificationEntries.</p></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#addDefaultSpecificationEntries"><code>addDefaultSpecificationEntries</code></a></dd> +</dl> +</li> +</ul> +<a name="isAddExtensions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAddExtensions</h4> +<pre>public boolean isAddExtensions()</pre> +<div class="block"><p>isAddExtensions.</p></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#addExtensions"><code>addExtensions</code></a></dd> +</dl> +</li> +</ul> +<a name="setAddClasspath-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAddClasspath</h4> +<pre>public void setAddClasspath(boolean addClasspath)</pre> +<div class="block"><p>Setter for the field <code>addClasspath</code>.</p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>addClasspath</code> - turn on addClasspath or off.</dd> +</dl> +</li> +</ul> +<a name="setAddDefaultEntries-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAddDefaultEntries</h4> +<pre>public void setAddDefaultEntries(boolean addDefaultEntries)</pre> +<div class="block"><p>Setter for the field <code>addDefaultEntries</code>.</p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>addDefaultEntries</code> - add default entries true/false.</dd> +</dl> +</li> +</ul> +<a name="setAddBuildEnvironmentEntries-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAddBuildEnvironmentEntries</h4> +<pre>public void setAddBuildEnvironmentEntries(boolean addBuildEnvironmentEntries)</pre> +<div class="block"><p>Setter for the field <code>addBuildEnvironmentEntries</code>.</p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>addBuildEnvironmentEntries</code> - add build environment information true/false.</dd> +</dl> +</li> +</ul> +<a name="setAddDefaultImplementationEntries-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAddDefaultImplementationEntries</h4> +<pre>public void setAddDefaultImplementationEntries(boolean addDefaultImplementationEntries)</pre> +<div class="block"><p>Setter for the field <code>addDefaultImplementationEntries</code>.</p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>addDefaultImplementationEntries</code> - true to add default implementations false otherwise.</dd> +</dl> +</li> +</ul> +<a name="setAddDefaultSpecificationEntries-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAddDefaultSpecificationEntries</h4> +<pre>public void setAddDefaultSpecificationEntries(boolean addDefaultSpecificationEntries)</pre> +<div class="block"><p>Setter for the field <code>addDefaultSpecificationEntries</code>.</p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>addDefaultSpecificationEntries</code> - add default specifications true/false.</dd> +</dl> +</li> +</ul> +<a name="setAddExtensions-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAddExtensions</h4> +<pre>public void setAddExtensions(boolean addExtensions)</pre> +<div class="block"><p>Setter for the field <code>addExtensions</code>.</p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>addExtensions</code> - true to add extensions false otherwise.</dd> +</dl> +</li> +</ul> +<a name="setClasspathPrefix-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setClasspathPrefix</h4> +<pre>public void setClasspathPrefix(<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> classpathPrefix)</pre> +<div class="block"><p>Setter for the field <code>classpathPrefix</code>.</p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>classpathPrefix</code> - The prefix.</dd> +</dl> +</li> +</ul> +<a name="setMainClass-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMainClass</h4> +<pre>public void setMainClass(<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> mainClass)</pre> +<div class="block"><p>Setter for the field <code>mainClass</code>.</p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>mainClass</code> - The main class.</dd> +</dl> +</li> +</ul> +<a name="setPackageName-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPackageName</h4> +<pre>public void setPackageName(<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> packageName)</pre> +<div class="block"><p>Setter for the field <code>packageName</code>.</p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>packageName</code> - The package name.</dd> +</dl> +</li> +</ul> +<a name="getClasspathPrefix--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClasspathPrefix</h4> +<pre>public <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> getClasspathPrefix()</pre> +<div class="block"><p>Getter for the field <code>classpathPrefix</code>.</p></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The classpath prefix.</dd> +</dl> +</li> +</ul> +<a name="getClasspathLayoutType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClasspathLayoutType</h4> +<pre>public <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> getClasspathLayoutType()</pre> +<div class="block">Return the type of layout to use when formatting classpath entries. Default is taken from the constant + CLASSPATH_LAYOUT_TYPE_SIMPLE, declared in this class, which has a value of 'simple'. Other values are: + 'repository' (CLASSPATH_LAYOUT_TYPE_REPOSITORY, or the same as a maven classpath layout), and 'custom' + (CLASSPATH_LAYOUT_TYPE_CUSTOM). <br> + <b>NOTE:</b> If you specify a type of 'custom' you MUST set + <a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setCustomClasspathLayout-java.lang.String-"><code>setCustomClasspathLayout(String)</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The classpath layout type.</dd> +</dl> +</li> +</ul> +<a name="setClasspathLayoutType-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setClasspathLayoutType</h4> +<pre>public void setClasspathLayoutType(<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> classpathLayoutType)</pre> +<div class="block">Set the type of layout to use when formatting classpath entries. Should be one of: 'simple' + (CLASSPATH_LAYOUT_TYPE_SIMPLE), 'repository' (CLASSPATH_LAYOUT_TYPE_REPOSITORY, or the same as a maven classpath + layout), and 'custom' (CLASSPATH_LAYOUT_TYPE_CUSTOM). The constant names noted here are defined in the + <a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html" title="class in org.apache.maven.archiver"><code>ManifestConfiguration</code></a> class. <br> + <b>NOTE:</b> If you specify a type of 'custom' you MUST set + <a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setCustomClasspathLayout-java.lang.String-"><code>setCustomClasspathLayout(String)</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>classpathLayoutType</code> - The classpath layout type.</dd> +</dl> +</li> +</ul> +<a name="getCustomClasspathLayout--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCustomClasspathLayout</h4> +<pre>public <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> getCustomClasspathLayout()</pre> +<div class="block">Retrieve the layout expression for use when the layout type set in + <a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setClasspathLayoutType-java.lang.String-"><code>setClasspathLayoutType(String)</code></a> has the value 'custom'. + <b>The default value is + null.</b> Expressions will be evaluated against the following ordered list of classpath-related objects: + <ol> + <li>The current <code>Artifact</code> instance, if one exists.</li> + <li>The current <code>ArtifactHandler</code> instance from the artifact above.</li> + </ol> + <br> + <b>NOTE:</b> If you specify a layout type of 'custom' you MUST set this layout expression.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The custom classpath layout.</dd> +</dl> +</li> +</ul> +<a name="setCustomClasspathLayout-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCustomClasspathLayout</h4> +<pre>public void setCustomClasspathLayout(<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> customClasspathLayout)</pre> +<div class="block">Set the layout expression for use when the layout type set in + <a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#setClasspathLayoutType-java.lang.String-"><code>setClasspathLayoutType(String)</code></a> has the value 'custom'. + Expressions will be + evaluated against the following ordered list of classpath-related objects: + <ol> + <li>The current <code>Artifact</code> instance, if one exists.</li> + <li>The current <code>ArtifactHandler</code> instance from the artifact above.</li> + </ol> + <br> + <b>NOTE:</b> If you specify a layout type of 'custom' you MUST set this layout expression. + You can take a look at + <ol> + <li><a href="../../../../org/apache/maven/archiver/MavenArchiver.html#SIMPLE_LAYOUT"><code>MavenArchiver.SIMPLE_LAYOUT</code></a></li> + <li><a href="../../../../org/apache/maven/archiver/MavenArchiver.html#SIMPLE_LAYOUT_NONUNIQUE"><code>MavenArchiver.SIMPLE_LAYOUT_NONUNIQUE</code></a></li> + <li><a href="../../../../org/apache/maven/archiver/MavenArchiver.html#REPOSITORY_LAYOUT"><code>MavenArchiver.REPOSITORY_LAYOUT</code></a></li> + <li><a href="../../../../org/apache/maven/archiver/MavenArchiver.html#REPOSITORY_LAYOUT_NONUNIQUE"><code>MavenArchiver.REPOSITORY_LAYOUT_NONUNIQUE</code></a></li> + </ol> + how such an expression looks like.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>customClasspathLayout</code> - The custom classpath layout.</dd> +</dl> +</li> +</ul> +<a name="isUseUniqueVersions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isUseUniqueVersions</h4> +<pre>public boolean isUseUniqueVersions()</pre> +<div class="block">Retrieve the flag for whether snapshot artifacts should be added to the classpath using the + timestamp/buildnumber version (the default, when this flag is true), or using the generic + -SNAPSHOT version (when the flag is false). <br> + <b>NOTE:</b> If the snapshot was installed locally, this flag will not have an effect on + that artifact's inclusion, since it will have the same version either way (i.e. -SNAPSHOT naming).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The state of <a href="../../../../org/apache/maven/archiver/ManifestConfiguration.html#useUniqueVersions"><code>useUniqueVersions</code></a></dd> +</dl> +</li> +</ul> +<a name="setUseUniqueVersions-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setUseUniqueVersions</h4> +<pre>public void setUseUniqueVersions(boolean useUniqueVersions)</pre> +<div class="block">Set the flag for whether snapshot artifacts should be added to the classpath using the timestamp/buildnumber + version (the default, when this flag is true), or using the generic -SNAPSHOT version (when the flag is false). + <br> + <b>NOTE:</b> If the snapshot was installed locally, this flag will not have an effect on that artifact's + inclusion, since it will have the same version either way (i.e. -SNAPSHOT naming).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>useUniqueVersions</code> - true to use unique versions or not.</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/archiver/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li>
[... 55 lines stripped ...]
