Modified: maven/website/components/plugins-archives/maven-help-plugin-LATEST/apidocs/org/apache/maven/plugins/help/AbstractHelpMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-help-plugin-LATEST/apidocs/org/apache/maven/plugins/help/AbstractHelpMojo.html (original) +++ maven/website/components/plugins-archives/maven-help-plugin-LATEST/apidocs/org/apache/maven/plugins/help/AbstractHelpMojo.html Sun Jun 2 15:20:18 2024 @@ -1,414 +1,577 @@ -<!DOCTYPE HTML> -<html lang="en"> -<head> -<!-- Generated by javadoc (17) --> -<title>AbstractHelpMojo (Apache Maven Help Plugin 3.4.0 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.plugins.help, class: AbstractHelpMojo"> -<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"> -<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> -<script type="text/javascript" src="../../../../../script.js"></script> -<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.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 evenRowColor = "even-row-color"; -var oddRowColor = "odd-row-color"; -var tableTab = "table-tab"; -var activeTableTab = "active-table-tab"; -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"> -<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/AbstractHelpMojo.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> -</div> -<div class="sub-nav"> -<div> -<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"><label for="search-input">SEARCH:</label> -<input type="text" id="search-input" value="search" disabled="disabled"> -<input type="reset" id="reset-button" value="reset" disabled="disabled"> -</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.plugins.help</a></div> -<h1 title="Class AbstractHelpMojo" class="title">Class AbstractHelpMojo</h1> -</div> -<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">java.lang.Object</a> -<div class="inheritance">org.apache.maven.plugin.AbstractMojo -<div class="inheritance">org.apache.maven.plugins.help.AbstractHelpMojo</div> -</div> -</div> -<section class="class-description" id="class-description"> -<dl class="notes"> -<dt>All Implemented Interfaces:</dt> -<dd><code>org.apache.maven.plugin.ContextEnabled</code>, <code>org.apache.maven.plugin.Mojo</code></dd> -</dl> -<dl class="notes"> -<dt>Direct Known Subclasses:</dt> -<dd><code><a href="AbstractEffectiveMojo.html" title="class in org.apache.maven.plugins.help">AbstractEffectiveMojo</a></code>, <code><a href="ActiveProfilesMojo.html" title="class in org.apache.maven.plugins.help">ActiveProfilesMojo</a></code>, <code><a href="AllProfilesMojo.html" title="class in org.apache.maven.plugins.help">AllProfilesMojo</a></code>, <code><a href="DescribeMojo.html" title="class in org.apache.maven.plugins.help">DescribeMojo</a></code>, <code><a href="EvaluateMojo.html" title="class in org.apache.maven.plugins.help">EvaluateMojo</a></code>, <code><a href="SystemMojo.html" title="class in org.apache.maven.plugins.help">SystemMojo</a></code></dd> -</dl> -<hr> -<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractHelpMojo</span> -<span class="extends-implements">extends org.apache.maven.plugin.AbstractMojo</span></div> -<div class="block">Base class with some Help Mojo functionalities.</div> -<dl class="notes"> -<dt>Since:</dt> -<dd>2.1</dd> -<dt>Author:</dt> -<dd><a href="mailto:vincent.sive...@gmail.com";>Vincent Siveton</a></dd> -</dl> -</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>protected static final int</code></div> -<div class="col-second even-row-color"><code><a href="#LINE_LENGTH" class="member-name-link">LINE_LENGTH</a></code></div> -<div class="col-last even-row-color"> -<div class="block">The maximum length of a display line.</div> -</div> -<div class="col-first odd-row-color"><code>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/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="#LS" class="member-name-link">LS</a></code></div> -<div class="col-last odd-row-color"> -<div class="block">The line separator for the current OS.</div> -</div> -<div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></code></div> -<div class="col-second even-row-color"><code><a href="#output" class="member-name-link">output</a></code></div> -<div class="col-last even-row-color"> -<div class="block">Optional parameter to write the output of this help in a given file, instead of writing to the console.</div> -</div> -<div class="col-first odd-row-color"><code>protected org.apache.maven.project.MavenProject</code></div> -<div class="col-second odd-row-color"><code><a href="#project" class="member-name-link">project</a></code></div> -<div class="col-last odd-row-color"> -<div class="block">Current Maven project.</div> -</div> -<div class="col-first even-row-color"><code>protected org.apache.maven.project.ProjectBuilder</code></div> -<div class="col-second even-row-color"><code><a href="#projectBuilder" class="member-name-link">projectBuilder</a></code></div> -<div class="col-last even-row-color"> -<div class="block">Maven Project Builder component.</div> -</div> -<div class="col-first odd-row-color"><code>protected org.eclipse.aether.RepositorySystem</code></div> -<div class="col-second odd-row-color"><code><a href="#repositorySystem" class="member-name-link">repositorySystem</a></code></div> -<div class="col-last odd-row-color"> -<div class="block">Component used to resolve artifacts and download their files from remote repositories.</div> -</div> -<div class="col-first even-row-color"><code>protected org.apache.maven.execution.MavenSession</code></div> -<div class="col-second even-row-color"><code><a href="#session" class="member-name-link">session</a></code></div> -<div class="col-last even-row-color"> -<div class="block">The current build session instance.</div> -</div> -</div> -<div class="inherited-list"> -<h3 id="fields-inherited-from-class-org.apache.maven.plugin.Mojo">Fields inherited from interface org.apache.maven.plugin.Mojo</h3> -<code>ROLE</code></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">AbstractHelpMojo</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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.ta bpanel" 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>protected org.eclipse.aether.artifact.Artifact</code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAetherArtifact(java.lang.String,java.lang.String)" class="member-name-link">getAetherArtifact</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> artifactString, - <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> type)</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Parses the given String into GAV artifact coordinate information, adding the given type.</div> -</div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected org.apache.maven.project.MavenProject</code></div> -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMavenProject(java.lang.String)" class="member-name-link">getMavenProject</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> artifactString)</code></div> -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> -<div class="block">Retrieves the Maven Project associated with the given artifact String, in the form of - <code>groupId:artifactId[:version]</code>.</div> -</div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected org.eclipse.aether.resolution.ArtifactResult</code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resolveArtifact(org.eclipse.aether.artifact.Artifact)" class="member-name-link">resolveArtifact</a><wbr>(org.eclipse.aether.artifact.Artifact artifact)</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> -<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static void</code></div> -<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#writeFile(java.io.File,java.lang.String)" class="member-name-link">writeFile</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> output, - <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> content)</code></div> -<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> -<div class="block">Utility method to write a content in a given file.</div> -</div> -<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static void</code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#writeFile(java.io.File,java.lang.StringBuilder)" class="member-name-link">writeFile</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> output, - <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html"; title="class or interface in java.lang" class="external-link">StringBuilder</a> content)</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> -<div class="block">Utility method to write a content in a given file.</div> -</div> -</div> -</div> -</div> -<div class="inherited-list"> -<h3 id="methods-inherited-from-class-org.apache.maven.plugin.AbstractMojo">Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3> -<code>getLog, getPluginContext, setLog, setPluginContext</code></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/javase/8/docs/api/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">Object</a></h3> -<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/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/javase/8/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.o racle.com/javase/8/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> -<div class="inherited-list"> -<h3 id="methods-inherited-from-class-org.apache.maven.plugin.Mojo">Methods inherited from interface org.apache.maven.plugin.Mojo</h3> -<code>execute</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="LINE_LENGTH"> -<h3>LINE_LENGTH</h3> -<div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name">LINE_LENGTH</span></div> -<div class="block">The maximum length of a display line.</div> -<dl class="notes"> -<dt>See Also:</dt> -<dd> -<ul class="see-list"> -<li><a href="../../../../../constant-values.html#org.apache.maven.plugins.help.AbstractHelpMojo.LINE_LENGTH">Constant Field Values</a></li> -</ul> -</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="LS"> -<h3>LS</h3> -<div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">LS</span></div> -<div class="block">The line separator for the current OS.</div> -</section> -</li> -<li> -<section class="detail" id="projectBuilder"> -<h3>projectBuilder</h3> -<div class="member-signature"><span class="annotations">@Component -</span><span class="modifiers">protected</span> <span class="return-type">org.apache.maven.project.ProjectBuilder</span> <span class="element-name">projectBuilder</span></div> -<div class="block">Maven Project Builder component.</div> -</section> -</li> -<li> -<section class="detail" id="repositorySystem"> -<h3>repositorySystem</h3> -<div class="member-signature"><span class="annotations">@Component -</span><span class="modifiers">protected</span> <span class="return-type">org.eclipse.aether.RepositorySystem</span> <span class="element-name">repositorySystem</span></div> -<div class="block">Component used to resolve artifacts and download their files from remote repositories.</div> -</section> -</li> -<li> -<section class="detail" id="project"> -<h3>project</h3> -<div class="member-signature"><span class="annotations">@Parameter(defaultValue="${project}", - readonly=true, - required=true) -</span><span class="modifiers">protected</span> <span class="return-type">org.apache.maven.project.MavenProject</span> <span class="element-name">project</span></div> -<div class="block">Current Maven project.</div> -</section> -</li> -<li> -<section class="detail" id="session"> -<h3>session</h3> -<div class="member-signature"><span class="annotations">@Parameter(defaultValue="${session}", - readonly=true, - required=true) -</span><span class="modifiers">protected</span> <span class="return-type">org.apache.maven.execution.MavenSession</span> <span class="element-name">session</span></div> -<div class="block">The current build session instance. This is used for - plugin manager API calls.</div> -</section> -</li> -<li> -<section class="detail" id="output"> -<h3>output</h3> -<div class="member-signature"><span class="annotations">@Parameter(property="output") -</span><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name">output</span></div> -<div class="block">Optional parameter to write the output of this help in a given file, instead of writing to the console. - <br> - <b>Note</b>: Could be a relative path.</div> -</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>AbstractHelpMojo</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AbstractHelpMojo</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="writeFile(java.io.File,java.lang.StringBuilder)"> -<h3>writeFile</h3> -<div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type">void</span> <span class="element-name">writeFile</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> output, - <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html"; title="class or interface in java.lang" class="external-link">StringBuilder</a> content)</span> - throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> -<div class="block">Utility method to write a content in a given file.</div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>output</code> - is the wanted output file.</dd> -<dd><code>content</code> - contains the content to be written to the file.</dd> -<dt>Throws:</dt> -<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - if any</dd> -<dt>See Also:</dt> -<dd> -<ul class="see-list-long"> -<li><a href="#writeFile(java.io.File,java.lang.String)"><code>writeFile(File, String)</code></a></li> -</ul> -</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="writeFile(java.io.File,java.lang.String)"> -<h3>writeFile</h3> -<div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type">void</span> <span class="element-name">writeFile</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> output, - <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> content)</span> - throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></span></div> -<div class="block">Utility method to write a content in a given file.</div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>output</code> - is the wanted output file.</dd> -<dd><code>content</code> - contains the content to be written to the file.</dd> -<dt>Throws:</dt> -<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html"; title="class or interface in java.io" class="external-link">IOException</a></code> - if any</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="getAetherArtifact(java.lang.String,java.lang.String)"> -<h3>getAetherArtifact</h3> -<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.eclipse.aether.artifact.Artifact</span> <span class="element-name">getAetherArtifact</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> artifactString, - <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> type)</span> - throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> -<div class="block">Parses the given String into GAV artifact coordinate information, adding the given type.</div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>artifactString</code> - should respect the format <code>groupId:artifactId[:version]</code></dd> -<dd><code>type</code> - The extension for the artifact, must not be <code>null</code>.</dd> -<dt>Returns:</dt> -<dd>the <code>Artifact</code> object for the <code>artifactString</code> parameter.</dd> -<dt>Throws:</dt> -<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if the <code>artifactString</code> doesn't respect the format.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="getMavenProject(java.lang.String)"> -<h3>getMavenProject</h3> -<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.apache.maven.project.MavenProject</span> <span class="element-name">getMavenProject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> artifactString)</span> - throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> -<div class="block">Retrieves the Maven Project associated with the given artifact String, in the form of - <code>groupId:artifactId[:version]</code>. This resolves the POM artifact at those coordinates and then builds - the Maven project from it.</div> -<dl class="notes"> -<dt>Parameters:</dt> -<dd><code>artifactString</code> - Coordinates of the Maven project to get.</dd> -<dt>Returns:</dt> -<dd>New Maven project.</dd> -<dt>Throws:</dt> -<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - If there was an error while getting the Maven project.</dd> -</dl> -</section> -</li> -<li> -<section class="detail" id="resolveArtifact(org.eclipse.aether.artifact.Artifact)"> -<h3>resolveArtifact</h3> -<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.eclipse.aether.resolution.ArtifactResult</span> <span class="element-name">resolveArtifact</span><wbr><span class="parameters">(org.eclipse.aether.artifact.Artifact artifact)</span> - throws <span class="exceptions">org.eclipse.aether.RepositoryException</span></div> -<dl class="notes"> -<dt>Throws:</dt> -<dd><code>org.eclipse.aether.RepositoryException</code></dd> -</dl> -</section> -</li> -</ul> -</section> -</li> -</ul> -</section> -<!-- ========= END OF CLASS DATA ========= --> -</main> -<footer role="contentinfo"> -<hr> -<p class="legal-copy"><small>Copyright © 2001–2023 <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>AbstractHelpMojo (Apache Maven Help Plugin 3.4.1 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="AbstractHelpMojo (Apache Maven Help Plugin 3.4.1 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/help/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractHelpMojo.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/help/AbstractEffectiveMojo.SortedProperties.html" title="class in org.apache.maven.plugins.help"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/maven/plugins/help/ActiveProfilesMojo.html" title="class in org.apache.maven.plugins.help"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/maven/plugins/help/AbstractHelpMojo.html" target="_top">Frames</a></li> +<li><a href="AbstractHelpMojo.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.plugins.help</div> +<h2 title="Class AbstractHelpMojo" class="title">Class AbstractHelpMojo</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.help.AbstractHelpMojo</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/help/AbstractEffectiveMojo.html" title="class in org.apache.maven.plugins.help">AbstractEffectiveMojo</a>, <a href="../../../../../org/apache/maven/plugins/help/ActiveProfilesMojo.html" title="class in org.apache.maven.plugins.help">ActiveProfilesMojo</a>, <a href="../../../../../org/apache/maven/plugins/help/AllProfilesMojo.html" title="class in org.apache.maven.plugins.help">AllProfilesMojo</a>, <a href="../../../../../org/apache/maven/plugins/help/DescribeMojo.html" title="class in org.apache.maven.plugins.help">DescribeMojo</a>, <a href="../../../../../org/apache/maven/plugins/help/EvaluateMojo.html" title="class in org.apache.maven.plugins.help">EvaluateMojo</a>, <a href="../../../../../org/apache/maven/plugins/help/SystemMojo.html" title="class in org.apache.maven.plugins.help">SystemMojo</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">AbstractHelpMojo</span> +extends org.apache.maven.plugin.AbstractMojo</pre> +<div class="block">Base class with some Help Mojo functionalities.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.1</dd> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd><a href="mailto:vincent.sive...@gmail.com";>Vincent Siveton</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>protected static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#LINE_LENGTH">LINE_LENGTH</a></span></code> +<div class="block">The maximum length of a display line.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected 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/plugins/help/AbstractHelpMojo.html#LS">LS</a></span></code> +<div class="block">The line separator for the current OS.</div> +</td> +</tr> +<tr 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/help/AbstractHelpMojo.html#output">output</a></span></code> +<div class="block">Optional parameter to write the output of this help in a given file, instead of writing to the console.</div> +</td> +</tr> +<tr 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/help/AbstractHelpMojo.html#project">project</a></span></code> +<div class="block">Current Maven project.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected org.apache.maven.project.ProjectBuilder</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#projectBuilder">projectBuilder</a></span></code> +<div class="block">Maven Project Builder component.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected org.eclipse.aether.RepositorySystem</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#repositorySystem">repositorySystem</a></span></code> +<div class="block">Component used to resolve artifacts and download their files from remote repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected org.apache.maven.execution.MavenSession</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#session">session</a></span></code> +<div class="block">The current build session instance.</div> +</td> +</tr> +</table> +<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/help/AbstractHelpMojo.html#AbstractHelpMojo--">AbstractHelpMojo</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>protected org.eclipse.aether.artifact.Artifact</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#getAetherArtifact-java.lang.String-java.lang.String-">getAetherArtifact</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> artifactString, + <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> type)</code> +<div class="block">Parses the given String into GAV artifact coordinate information, adding the given type.</div> +</td> +</tr> +<tr id="i1" 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/help/AbstractHelpMojo.html#getMavenProject-java.lang.String-">getMavenProject</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> artifactString)</code> +<div class="block">Retrieves the Maven Project associated with the given artifact String, in the form of + <code>groupId:artifactId[:version]</code>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>protected org.eclipse.aether.resolution.ArtifactResult</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#resolveArtifact-org.eclipse.aether.artifact.Artifact-">resolveArtifact</a></span>(org.eclipse.aether.artifact.Artifact artifact)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#writeFile-java.io.File-java.lang.String-">writeFile</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> output, + <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> content)</code> +<div class="block">Utility method to write a content in a given file.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#writeFile-java.io.File-java.lang.StringBuilder-">writeFile</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> output, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true"; title="class or interface in java.lang">StringBuilder</a> content)</code> +<div class="block">Utility method to write a content in a given file.</div> +</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> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugin.Mojo"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.maven.plugin.Mojo</h3> +<code>execute</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="LINE_LENGTH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LINE_LENGTH</h4> +<pre>protected static final int LINE_LENGTH</pre> +<div class="block">The maximum length of a display line.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.maven.plugins.help.AbstractHelpMojo.LINE_LENGTH">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="LS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LS</h4> +<pre>protected 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> LS</pre> +<div class="block">The line separator for the current OS.</div> +</li> +</ul> +<a name="projectBuilder"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>projectBuilder</h4> +<pre>@Component +protected org.apache.maven.project.ProjectBuilder projectBuilder</pre> +<div class="block">Maven Project Builder component.</div> +</li> +</ul> +<a name="repositorySystem"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>repositorySystem</h4> +<pre>@Component +protected org.eclipse.aether.RepositorySystem repositorySystem</pre> +<div class="block">Component used to resolve artifacts and download their files from remote repositories.</div> +</li> +</ul> +<a name="project"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>project</h4> +<pre>@Parameter(defaultValue="${project}", + readonly=true, + required=true) +protected org.apache.maven.project.MavenProject project</pre> +<div class="block">Current Maven project.</div> +</li> +</ul> +<a name="session"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>session</h4> +<pre>@Parameter(defaultValue="${session}", + readonly=true, + required=true) +protected org.apache.maven.execution.MavenSession session</pre> +<div class="block">The current build session instance. This is used for + plugin manager API calls.</div> +</li> +</ul> +<a name="output"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>output</h4> +<pre>@Parameter(property="output") +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> output</pre> +<div class="block">Optional parameter to write the output of this help in a given file, instead of writing to the console. + <br> + <b>Note</b>: Could be a relative path.</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AbstractHelpMojo--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractHelpMojo</h4> +<pre>public AbstractHelpMojo()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="writeFile-java.io.File-java.lang.StringBuilder-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeFile</h4> +<pre>protected static void writeFile(<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> output, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true"; title="class or interface in java.lang">StringBuilder</a> content) + throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Utility method to write a content in a given file.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>output</code> - is the wanted output file.</dd> +<dd><code>content</code> - contains the content to be written to the file.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if any</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#writeFile-java.io.File-java.lang.String-"><code>writeFile(File, String)</code></a></dd> +</dl> +</li> +</ul> +<a name="writeFile-java.io.File-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeFile</h4> +<pre>protected static void writeFile(<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> output, + <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> content) + throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Utility method to write a content in a given file.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>output</code> - is the wanted output file.</dd> +<dd><code>content</code> - contains the content to be written to the file.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if any</dd> +</dl> +</li> +</ul> +<a name="getAetherArtifact-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAetherArtifact</h4> +<pre>protected org.eclipse.aether.artifact.Artifact getAetherArtifact(<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> artifactString, + <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> type) + throws org.apache.maven.plugin.MojoExecutionException</pre> +<div class="block">Parses the given String into GAV artifact coordinate information, adding the given type.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>artifactString</code> - should respect the format <code>groupId:artifactId[:version]</code></dd> +<dd><code>type</code> - The extension for the artifact, must not be <code>null</code>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <code>Artifact</code> object for the <code>artifactString</code> parameter.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if the <code>artifactString</code> doesn't respect the format.</dd> +</dl> +</li> +</ul> +<a name="getMavenProject-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMavenProject</h4> +<pre>protected org.apache.maven.project.MavenProject getMavenProject(<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> artifactString) + throws org.apache.maven.plugin.MojoExecutionException</pre> +<div class="block">Retrieves the Maven Project associated with the given artifact String, in the form of + <code>groupId:artifactId[:version]</code>. This resolves the POM artifact at those coordinates and then builds + the Maven project from it.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>artifactString</code> - Coordinates of the Maven project to get.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>New Maven project.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - If there was an error while getting the Maven project.</dd> +</dl> +</li> +</ul> +<a name="resolveArtifact-org.eclipse.aether.artifact.Artifact-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>resolveArtifact</h4> +<pre>protected org.eclipse.aether.resolution.ArtifactResult resolveArtifact(org.eclipse.aether.artifact.Artifact artifact) + throws org.eclipse.aether.RepositoryException</pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.eclipse.aether.RepositoryException</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/help/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractHelpMojo.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/help/AbstractEffectiveMojo.SortedProperties.html" title="class in org.apache.maven.plugins.help"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/maven/plugins/help/ActiveProfilesMojo.html" title="class in org.apache.maven.plugins.help"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/maven/plugins/help/AbstractHelpMojo.html" target="_top">Frames</a></li> +<li><a href="AbstractHelpMojo.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><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.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2001–2024 <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-help-plugin-LATEST/apidocs/org/apache/maven/plugins/help/ActiveProfilesMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-help-plugin-LATEST/apidocs/org/apache/maven/plugins/help/ActiveProfilesMojo.html (original) +++ maven/website/components/plugins-archives/maven-help-plugin-LATEST/apidocs/org/apache/maven/plugins/help/ActiveProfilesMojo.html Sun Jun 2 15:20:18 2024 @@ -1,199 +1,332 @@ -<!DOCTYPE HTML> -<html lang="en"> -<head> -<!-- Generated by javadoc (17) --> -<title>ActiveProfilesMojo (Apache Maven Help Plugin 3.4.0 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.plugins.help, class: ActiveProfilesMojo"> -<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"> -<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> -<script type="text/javascript" src="../../../../../script.js"></script> -<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.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 evenRowColor = "even-row-color"; -var oddRowColor = "odd-row-color"; -var tableTab = "table-tab"; -var activeTableTab = "active-table-tab"; -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"> -<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/ActiveProfilesMojo.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> -</div> -<div class="sub-nav"> -<div> -<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>Field | </li> -<li><a href="#constructor-detail">Constr</a> | </li> -<li><a href="#method-detail">Method</a></li> -</ul> -</div> -<div class="nav-list-search"><label for="search-input">SEARCH:</label> -<input type="text" id="search-input" value="search" disabled="disabled"> -<input type="reset" id="reset-button" value="reset" disabled="disabled"> -</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.plugins.help</a></div> -<h1 title="Class ActiveProfilesMojo" class="title">Class ActiveProfilesMojo</h1> -</div> -<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">java.lang.Object</a> -<div class="inheritance">org.apache.maven.plugin.AbstractMojo -<div class="inheritance"><a href="AbstractHelpMojo.html" title="class in org.apache.maven.plugins.help">org.apache.maven.plugins.help.AbstractHelpMojo</a> -<div class="inheritance">org.apache.maven.plugins.help.ActiveProfilesMojo</div> -</div> -</div> -</div> -<section class="class-description" id="class-description"> -<dl class="notes"> -<dt>All Implemented Interfaces:</dt> -<dd><code>org.apache.maven.plugin.ContextEnabled</code>, <code>org.apache.maven.plugin.Mojo</code></dd> -</dl> -<hr> -<div class="type-signature"><span class="annotations">@Mojo(name="active-profiles", - aggregator=true) -</span><span class="modifiers">public class </span><span class="element-name type-name-label">ActiveProfilesMojo</span> -<span class="extends-implements">extends <a href="AbstractHelpMojo.html" title="class in org.apache.maven.plugins.help">AbstractHelpMojo</a></span></div> -<div class="block">Displays a list of the profiles which are currently active for this build.</div> -<dl class="notes"> -<dt>Since:</dt> -<dd>2.0</dd> -</dl> -</section> -<section class="summary"> -<ul class="summary-list"> -<!-- =========== FIELD SUMMARY =========== --> -<li> -<section class="field-summary" id="field-summary"> -<h2>Field Summary</h2> -<div class="inherited-list"> -<h3 id="fields-inherited-from-class-org.apache.maven.plugins.help.AbstractHelpMojo">Fields inherited from class org.apache.maven.plugins.help.<a href="AbstractHelpMojo.html" title="class in org.apache.maven.plugins.help">AbstractHelpMojo</a></h3> -<code><a href="AbstractHelpMojo.html#LINE_LENGTH">LINE_LENGTH</a>, <a href="AbstractHelpMojo.html#LS">LS</a>, <a href="AbstractHelpMojo.html#output">output</a>, <a href="AbstractHelpMojo.html#project">project</a>, <a href="AbstractHelpMojo.html#projectBuilder">projectBuilder</a>, <a href="AbstractHelpMojo.html#repositorySystem">repositorySystem</a>, <a href="AbstractHelpMojo.html#session">session</a></code></div> -<div class="inherited-list"> -<h3 id="fields-inherited-from-class-org.apache.maven.plugin.Mojo">Fields inherited from interface org.apache.maven.plugin.Mojo</h3> -<code>ROLE</code></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">ActiveProfilesMojo</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>void</code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div> -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> -</div> -</div> -</div> -<div class="inherited-list"> -<h3 id="methods-inherited-from-class-org.apache.maven.plugins.help.AbstractHelpMojo">Methods inherited from class org.apache.maven.plugins.help.<a href="AbstractHelpMojo.html" title="class in org.apache.maven.plugins.help">AbstractHelpMojo</a></h3> -<code><a href="AbstractHelpMojo.html#getAetherArtifact(java.lang.String,java.lang.String)">getAetherArtifact</a>, <a href="AbstractHelpMojo.html#getMavenProject(java.lang.String)">getMavenProject</a>, <a href="AbstractHelpMojo.html#resolveArtifact(org.eclipse.aether.artifact.Artifact)">resolveArtifact</a>, <a href="AbstractHelpMojo.html#writeFile(java.io.File,java.lang.String)">writeFile</a>, <a href="AbstractHelpMojo.html#writeFile(java.io.File,java.lang.StringBuilder)">writeFile</a></code></div> -<div class="inherited-list"> -<h3 id="methods-inherited-from-class-org.apache.maven.plugin.AbstractMojo">Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3> -<code>getLog, getPluginContext, setLog, setPluginContext</code></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/javase/8/docs/api/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">Object</a></h3> -<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/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/javase/8/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.o racle.com/javase/8/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/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"> -<!-- ========= 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>ActiveProfilesMojo</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ActiveProfilesMojo</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="execute()"> -<h3>execute</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">execute</span>() - throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> -<dl class="notes"> -<dt>Throws:</dt> -<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> -</dl> -</section> -</li> -</ul> -</section> -</li> -</ul> -</section> -<!-- ========= END OF CLASS DATA ========= --> -</main> -<footer role="contentinfo"> -<hr> -<p class="legal-copy"><small>Copyright © 2001–2023 <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>ActiveProfilesMojo (Apache Maven Help Plugin 3.4.1 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="ActiveProfilesMojo (Apache Maven Help Plugin 3.4.1 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/help/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ActiveProfilesMojo.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/help/AbstractHelpMojo.html" title="class in org.apache.maven.plugins.help"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/maven/plugins/help/AllProfilesMojo.html" title="class in org.apache.maven.plugins.help"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/maven/plugins/help/ActiveProfilesMojo.html" target="_top">Frames</a></li> +<li><a href="ActiveProfilesMojo.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="#fields.inherited.from.class.org.apache.maven.plugins.help.AbstractHelpMojo">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>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.help</div> +<h2 title="Class ActiveProfilesMojo" class="title">Class ActiveProfilesMojo</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><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html" title="class in org.apache.maven.plugins.help">org.apache.maven.plugins.help.AbstractHelpMojo</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.plugins.help.ActiveProfilesMojo</li> +</ul> +</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="active-profiles", + aggregator=true) +public class <span class="typeNameLabel">ActiveProfilesMojo</span> +extends <a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html" title="class in org.apache.maven.plugins.help">AbstractHelpMojo</a></pre> +<div class="block">Displays a list of the profiles which are currently active for this build.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.0</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.plugins.help.AbstractHelpMojo"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.maven.plugins.help.<a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html" title="class in org.apache.maven.plugins.help">AbstractHelpMojo</a></h3> +<code><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#LINE_LENGTH">LINE_LENGTH</a>, <a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#LS">LS</a>, <a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#output">output</a>, <a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#project">project</a>, <a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#projectBuilder">projectBuilder</a>, <a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#repositorySystem">repositorySystem</a>, <a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#session">session</a></code></li> +</ul> +<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/help/ActiveProfilesMojo.html#ActiveProfilesMojo--">ActiveProfilesMojo</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/help/ActiveProfilesMojo.html#execute--">execute</a></span>()</code></td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugins.help.AbstractHelpMojo"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.maven.plugins.help.<a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html" title="class in org.apache.maven.plugins.help">AbstractHelpMojo</a></h3> +<code><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#getAetherArtifact-java.lang.String-java.lang.String-">getAetherArtifact</a>, <a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#getMavenProject-java.lang.String-">getMavenProject</a>, <a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#resolveArtifact-org.eclipse.aether.artifact.Artifact-">resolveArtifact</a>, <a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#writeFile-java.io.File-java.lang.String-">writeFile</a>, <a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#writeFile-java.io.File-java.lang.StringBuilder-">writeFile</a></code></li> +</ul> +<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="ActiveProfilesMojo--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ActiveProfilesMojo</h4> +<pre>public ActiveProfilesMojo()</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/help/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ActiveProfilesMojo.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/help/AbstractHelpMojo.html" title="class in org.apache.maven.plugins.help"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/maven/plugins/help/AllProfilesMojo.html" title="class in org.apache.maven.plugins.help"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/maven/plugins/help/ActiveProfilesMojo.html" target="_top">Frames</a></li> +<li><a href="ActiveProfilesMojo.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><a href="#fields.inherited.from.class.org.apache.maven.plugins.help.AbstractHelpMojo">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>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 © 2001–2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> </html> \ No newline at end of file
