Modified: websites/production/maven/components/plugins-archives/maven-help-plugin-LATEST/apidocs/org/apache/maven/plugins/help/AbstractHelpMojo.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-help-plugin-LATEST/apidocs/org/apache/maven/plugins/help/AbstractHelpMojo.html (original) +++ websites/production/maven/components/plugins-archives/maven-help-plugin-LATEST/apidocs/org/apache/maven/plugins/help/AbstractHelpMojo.html Wed Mar 7 21:32:07 2018 @@ -1,389 +1,563 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<TITLE> -AbstractHelpMojo (Maven Help Plugin 2.2 API) -</TITLE> - - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="AbstractHelpMojo (Maven Help Plugin 2.2 API)"; +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AbstractHelpMojo (Apache Maven Help Plugin 3.0.0 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="AbstractHelpMojo (Apache Maven Help Plugin 3.0.0 API)"; + } } -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> -<HR> - - + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<A NAME="navbar_top"><!-- --></A> -<A HREF="#skip-navbar_top" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_top_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../org/apache/maven/plugins/help/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractHelpMojo.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -</EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../../org/apache/maven/plugins/help/AbstractEffectiveMojo.SortedProperties.html" title="class in org.apache.maven.plugins.help"><B>PREV CLASS</B></A> - <A HREF="../../../../../org/apache/maven/plugins/help/ActiveProfilesMojo.html" title="class in org.apache.maven.plugins.help"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../../index.html?org/apache/maven/plugins/help/AbstractHelpMojo.html" target="_top"><B>FRAMES</B></A> - <A HREF="AbstractHelpMojo.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">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="strong">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) { - document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> +</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 ========= --> - -<HR> <!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -org.apache.maven.plugins.help</FONT> -<BR> -Class AbstractHelpMojo</H2> -<PRE> -<A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">org.apache.maven.plugin.AbstractMojo - <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.maven.plugins.help.AbstractHelpMojo</B> -</PRE> -<DL> -<DT><B>All Implemented Interfaces:</B> <DD>org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo</DD> -</DL> -<DL> -<DT><B>Direct Known Subclasses:</B> <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/ExpressionsMojo.html" title="class in org.apache.maven.plugins.help">ExpressionsMojo</A>, <A HREF="../../../../../org/apache/maven/plugins/help/SystemMojo.html" title="class in org.apache.maven.plugins.help">SystemMojo</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public abstract class <B>AbstractHelpMojo</B><DT>extends org.apache.maven.plugin.AbstractMojo</DL> -</PRE> - -<P> -Base class with some Help Mojo functionalities. -<P> - -<P> -<DL> -<DT><B>Since:</B></DT> - <DD>2.1</DD> -<DT><B>Version:</B></DT> - <DD>$Id: AbstractHelpMojo.java 1384337 2012-09-13 13:53:19Z olamy $</DD> -<DT><B>Author:</B></DT> - <DD><a href="mailto:vincent.sive...@gmail.com">Vincent Siveton</a></DD> -</DL> -<HR> - -<P> +<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/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">org.apache.maven.plugin.AbstractMojo</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.plugins.help.AbstractHelpMojo</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/ContextEnabled.html?is-external=true" title="class or interface in org.apache.maven.plugin">ContextEnabled</a>, <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">Mojo</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/maven/plugins/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="strong">AbstractHelpMojo</span> +extends <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">AbstractMojo</a></pre> +<div class="block">Base class with some Help Mojo functionalities.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.1</dd> +<dt><span class="strong">Version:</span></dt> + <dd>$Id$</dd> +<dt><span class="strong">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 =========== --> - -<A NAME="field_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Field Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected static int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#LINE_LENGTH">LINE_LENGTH</A></B></CODE> - -<BR> - The maximum length of a display line.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#output">output</A></B></CODE> - -<BR> - Optional parameter to write the output of this help in a given file, instead of writing to the console.</TD> -</TR> -</TABLE> - <A NAME="fields_inherited_from_class_org.apache.maven.plugin.Mojo"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Fields inherited from interface org.apache.maven.plugin.Mojo</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>ROLE</CODE></TD> -</TR> -</TABLE> - +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" 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 <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/shared.artifact.resolve.ArtifactResolver.html?is-external=true" title="class or interface in org.apache.maven">org.apache.maven.shared.artifact.resolve.ArtifactResolver</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#artifactResolver">artifactResolver</a></strong></code> +<div class="block">Component used to resolve artifacts and download their files from remote repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#LINE_LENGTH">LINE_LENGTH</a></strong></code> +<div class="block">The maximum length of a display line.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#localRepository">localRepository</a></strong></code> +<div class="block">Local Repository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#LS">LS</a></strong></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/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#output">output</a></strong></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 <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/project/ProjectBuilder.html?is-external=true" title="class or interface in org.apache.maven.project">ProjectBuilder</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#projectBuilder">projectBuilder</a></strong></code> +<div class="block">Maven Project Builder component.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#remoteRepositories">remoteRepositories</a></strong></code> +<div class="block">Remote repositories used for the project.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/execution/MavenSession.html?is-external=true" title="class or interface in org.apache.maven.execution">MavenSession</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#session">session</a></strong></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.<a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">Mojo</a></h3> +<code><a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true#ROLE" title="class or interface in org.apache.maven.plugin">ROLE</a></code></li> +</ul> +</li> +</ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> - -<A NAME="constructor_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Constructor Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#AbstractHelpMojo()">AbstractHelpMojo</A></B>()</CODE> - -<BR> - </TD> -</TR> -</TABLE> - +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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><strong><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#AbstractHelpMojo()">AbstractHelpMojo</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> <!-- ========== METHOD SUMMARY =========== --> - -<A NAME="method_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Method Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected static void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#writeFile(java.io.File, java.lang.String)">writeFile</A></B>(<A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> output, - <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> content)</CODE> - -<BR> - Utility method to write a content in a given file.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected static void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#writeFile(java.io.File, java.lang.StringBuilder)">writeFile</A></B>(<A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> output, - <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</A> content)</CODE> - -<BR> - Utility method to write a content in a given file.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_org.apache.maven.plugin.AbstractMojo"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class org.apache.maven.plugin.AbstractMojo</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>getLog, getPluginContext, setLog, setPluginContext</CODE></TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://docs.oracle.com /javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_org.apache.maven.plugin.Mojo"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from interface org.apache.maven.plugin.Mojo</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>execute</CODE></TD> -</TR> -</TABLE> - -<P> - +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/shared.artifact.ArtifactCoordinate.html?is-external=true" title="class or interface in org.apache.maven">org.apache.maven.shared.artifact.ArtifactCoordinate</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#getArtifactCoordinate(java.lang.String,%20java.lang.String)">getArtifactCoordinate</a></strong>(<a href="https://docs.oracle.com/javase/7/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/7/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 class="rowColor"> +<td class="colFirst"><code>protected <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/shared.artifact.ArtifactCoordinate.html?is-external=true" title="class or interface in org.apache.maven">org.apache.maven.shared.artifact.ArtifactCoordinate</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#getArtifactCoordinate(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)">getArtifactCoordinate</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> groupId, + <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> artifactId, + <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> version, + <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#getMavenProject(java.lang.String)">getMavenProject</a></strong>(<a href="https://docs.oracle.com/javase/7/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 class="rowColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#writeFile(java.io.File,%20java.lang.String)">writeFile</a></strong>(<a href="https://docs.oracle.com/javase/7/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/7/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 class="altColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#writeFile(java.io.File,%20java.lang.StringBuilder)">writeFile</a></strong>(<a href="https://docs.oracle.com/javase/7/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/7/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.<a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">AbstractMojo</a></h3> +<code><a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#getLog()" title="class or interface in org.apache.maven.plugin">getLog</a>, <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#getPluginContext()" title="class or interface in org.apache.maven.plugin">getPluginContext</a>, <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#setLog(org.apache.maven.plugin.logging.Log)" title="class or interface in org.apache.maven.plugin">setLog</a>, <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#setPluginContext(java.util.Map)" title="class or interface in org.apache.maven.plugin">setPluginContext</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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.<a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">Mojo</a></h3> +<code><a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true#execute()" title="class or interface in org.apache.maven.plugin">execute</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> <!-- ============ FIELD DETAIL =========== --> - -<A NAME="field_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Field Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="LINE_LENGTH"><!-- --></A><H3> -LINE_LENGTH</H3> -<PRE> -protected static final int <B>LINE_LENGTH</B></PRE> -<DL> -<DD>The maximum length of a display line. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.maven.plugins.help.AbstractHelpMojo.LINE_LENGTH">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="output"><!-- --></A><H3> -output</H3> -<PRE> -<FONT SIZE="-1"><A HREF="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</A>(<A HREF="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#property()" title="class or interface in org.apache.maven.plugins.annotations">property</A>="output") -</FONT>protected <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> <B>output</B></PRE> -<DL> -<DD>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. -<P> -<DL> -</DL> -</DL> - +<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="strong">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/7/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><a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugins.annotations.Component.html?is-external=true" title="class or interface in org.apache.maven">@Component</a> +protected <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/project/ProjectBuilder.html?is-external=true" title="class or interface in org.apache.maven.project">ProjectBuilder</a> projectBuilder</pre> +<div class="block">Maven Project Builder component.</div> +</li> +</ul> +<a name="artifactResolver"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>artifactResolver</h4> +<pre><a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugins.annotations.Component.html?is-external=true" title="class or interface in org.apache.maven">@Component</a> +protected <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/shared.artifact.resolve.ArtifactResolver.html?is-external=true" title="class or interface in org.apache.maven">org.apache.maven.shared.artifact.resolve.ArtifactResolver</a> artifactResolver</pre> +<div class="block">Component used to resolve artifacts and download their files from remote repositories.</div> +</li> +</ul> +<a name="remoteRepositories"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remoteRepositories</h4> +<pre><a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugins.annotations.Parameter.html?is-external=true" title="class or interface in org.apache.maven">@Parameter</a>(defaultValue="${project.remoteArtifactRepositories}", + required=true, + readonly=true) +protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a>> remoteRepositories</pre> +<div class="block">Remote repositories used for the project.</div> +</li> +</ul> +<a name="localRepository"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>localRepository</h4> +<pre><a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugins.annotations.Parameter.html?is-external=true" title="class or interface in org.apache.maven">@Parameter</a>(defaultValue="${localRepository}", + required=true, + readonly=true) +protected <a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository</pre> +<div class="block">Local Repository.</div> +</li> +</ul> +<a name="session"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>session</h4> +<pre><a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugins.annotations.Parameter.html?is-external=true" title="class or interface in org.apache.maven">@Parameter</a>(defaultValue="${session}", + readonly=true, + required=true) +protected <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/execution/MavenSession.html?is-external=true" title="class or interface in org.apache.maven.execution">MavenSession</a> 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><a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugins.annotations.Parameter.html?is-external=true" title="class or interface in org.apache.maven">@Parameter</a>(property="output") +protected <a href="https://docs.oracle.com/javase/7/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 ======== --> - -<A NAME="constructor_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Constructor Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="AbstractHelpMojo()"><!-- --></A><H3> -AbstractHelpMojo</H3> -<PRE> -public <B>AbstractHelpMojo</B>()</PRE> -<DL> -</DL> - +<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 ========== --> - -<A NAME="method_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Method Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="writeFile(java.io.File, java.lang.StringBuilder)"><!-- --></A><H3> -writeFile</H3> -<PRE> -protected static void <B>writeFile</B>(<A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> output, - <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</A> content) - throws <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> -<DL> -<DD>Utility method to write a content in a given file. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>output</CODE> - is the wanted output file.<DD><CODE>content</CODE> - contains the content to be written to the file. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if any<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#writeFile(java.io.File, java.lang.String)"><CODE>writeFile(File, String)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="writeFile(java.io.File, java.lang.String)"><!-- --></A><H3> -writeFile</H3> -<PRE> -protected static void <B>writeFile</B>(<A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> output, - <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> content) - throws <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> -<DL> -<DD>Utility method to write a content in a given file. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>output</CODE> - is the wanted output file.<DD><CODE>content</CODE> - contains the content to be written to the file. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if any</DL> -</DD> -</DL> +<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/7/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/7/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/7/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="strong">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="strong">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/7/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="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#writeFile(java.io.File,%20java.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/7/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/7/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/7/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="strong">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="strong">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/7/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="getArtifactCoordinate(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getArtifactCoordinate</h4> +<pre>protected <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/shared.artifact.ArtifactCoordinate.html?is-external=true" title="class or interface in org.apache.maven">org.apache.maven.shared.artifact.ArtifactCoordinate</a> getArtifactCoordinate(<a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type) + throws <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/MojoExecutionException.html?is-external=true" title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></pre> +<div class="block">Parses the given String into GAV artifact coordinate information, adding the given type.</div> +<dl><dt><span class="strong">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="strong">Returns:</span></dt><dd>the <code>Artifact</code> object for the <code>artifactString</code> parameter.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/MojoExecutionException.html?is-external=true" title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></code> - if the <code>artifactString</code> doesn't respect the format.</dd></dl> +</li> +</ul> +<a name="getArtifactCoordinate(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getArtifactCoordinate</h4> +<pre>protected <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/shared.artifact.ArtifactCoordinate.html?is-external=true" title="class or interface in org.apache.maven">org.apache.maven.shared.artifact.ArtifactCoordinate</a> getArtifactCoordinate(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> groupId, + <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> artifactId, + <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> version, + <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</pre> +</li> +</ul> +<a name="getMavenProject(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMavenProject</h4> +<pre>protected <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> getMavenProject(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> artifactString) + throws <a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/MojoExecutionException.html?is-external=true" title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></pre> +<div class="block">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="strong">Parameters:</span></dt><dd><code>artifactString</code> - Coordinates of the Maven project to get.</dd> +<dt><span class="strong">Returns:</span></dt><dd>New Maven project.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://maven.apache.org/maven-core/apidocs/org/apache/maven/plugin/MojoExecutionException.html?is-external=true" title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></code> - If there was an error while getting the Maven project.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> <!-- ========= END OF CLASS DATA ========= --> -<HR> - - <!-- ======= START OF BOTTOM NAVBAR ====== --> -<A NAME="navbar_bottom"><!-- --></A> -<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_bottom_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../org/apache/maven/plugins/help/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractHelpMojo.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -</EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../../org/apache/maven/plugins/help/AbstractEffectiveMojo.SortedProperties.html" title="class in org.apache.maven.plugins.help"><B>PREV CLASS</B></A> - <A HREF="../../../../../org/apache/maven/plugins/help/ActiveProfilesMojo.html" title="class in org.apache.maven.plugins.help"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../../index.html?org/apache/maven/plugins/help/AbstractHelpMojo.html" target="_top"><B>FRAMES</B></A> - <A HREF="AbstractHelpMojo.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">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="strong">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) { - document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> +</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 ======= --> - -<HR> -Copyright © 2001-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. -</BODY> -</HTML> \ No newline at end of file +<p class="legalCopy"><small>Copyright © 2001–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> \ No newline at end of file