Modified: websites/production/maven/content/shared-archives/maven-reporting-impl-LATEST/apidocs/org/apache/maven/reporting/AbstractMavenReport.html ============================================================================== --- websites/production/maven/content/shared-archives/maven-reporting-impl-LATEST/apidocs/org/apache/maven/reporting/AbstractMavenReport.html (original) +++ websites/production/maven/content/shared-archives/maven-reporting-impl-LATEST/apidocs/org/apache/maven/reporting/AbstractMavenReport.html Sun Sep 14 15:45:30 2014 @@ -1,715 +1,701 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<!-- Generated by javadoc (build 1.5.0_22) on Sun Feb 12 10:57:45 CET 2012 --> -<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<TITLE> -AbstractMavenReport (Maven Reporting Implementation 2.2 API) -</TITLE> - -<META NAME="keywords" CONTENT="org.apache.maven.reporting.AbstractMavenReport class"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ - parent.document.title="AbstractMavenReport (Maven Reporting Implementation 2.2 API)"; -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> - - -<!-- ========= 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/reporting/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/AbstractMavenReport.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"> - PREV CLASS - <A HREF="../../../../org/apache/maven/reporting/AbstractMavenReportRenderer.html" title="class in org.apache.maven.reporting"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/maven/reporting/AbstractMavenReport.html" target="_top"><B>FRAMES</B></A> - <A HREF="AbstractMavenReport.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- - if(window==top) { - document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); - } - //--> -</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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> -<!-- ========= END OF TOP NAVBAR ========= --> - -<HR> -<!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -org.apache.maven.reporting</FONT> -<BR> -Class AbstractMavenReport</H2> -<PRE> -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html" title="class or interface in org.apache.maven.plugin">org.apache.maven.plugin.AbstractMojo</A> - <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.maven.reporting.AbstractMavenReport</B> -</PRE> -<DL> -<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/ContextEnabled.html" title="class or interface in org.apache.maven.plugin">ContextEnabled</A>, <A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html" title="class or interface in org.apache.maven.plugin">Mojo</A>, <A HREF="../../../../org/apache/maven/reporting/MavenMultiPageReport.html" title="interface in org.apache.maven.reporting">MavenMultiPageReport</A>, <A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html" title="class or interface in org.apache.maven.reporting">MavenReport</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public abstract class <B>AbstractMavenReport</B><DT>extends <A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html" title="class or interface in org.apache.maven.plugin">AbstractMojo</A><DT>implements <A HREF="../../../../org/apache/maven/reporting/MavenMultiPageReport.html" title="interface in org.apache.maven.reporting">MavenMultiPageReport</A></DL> -</PRE> - -<P> -The basis for a Maven report which can be generated both as part of a site generation or - as a direct standalone invocation. - Both invocations are delegated to <a href=""><code>abstract executeReport( Locale )</code></a>: +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="fr"> +<head> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>AbstractMavenReport (Apache Maven Reporting Implementation 2.3 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="AbstractMavenReport (Apache Maven Reporting Implementation 2.3 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<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/reporting/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractMavenReport.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../org/apache/maven/reporting/AbstractMavenReportRenderer.html" title="class in org.apache.maven.reporting"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/maven/reporting/AbstractMavenReport.html" target="_top">Frames</a></li> +<li><a href="AbstractMavenReport.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.reporting</div> +<h2 title="Class AbstractMavenReport" class="title">Class AbstractMavenReport</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><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></li> +<li> +<ul class="inheritance"> +<li><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">org.apache.maven.plugin.AbstractMojo</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.reporting.AbstractMavenReport</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-plugin-api/apidocs/org/apache/maven/plugin/ContextEnabled.html?is-external=true" title="class or interface in org.apache.maven.plugin">ContextEnabled</a>, <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">Mojo</a>, <a href="../../../../org/apache/maven/reporting/MavenMultiPageReport.html" title="interface in org.apache.maven.reporting">MavenMultiPageReport</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractMavenReport</span> +extends <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">AbstractMojo</a> +implements <a href="../../../../org/apache/maven/reporting/MavenMultiPageReport.html" title="interface in org.apache.maven.reporting">MavenMultiPageReport</a></pre> +<div class="block">The basis for a Maven report which can be generated both as part of a site generation or + as a direct standalone goal invocation. + Both invocations are delegated to <code>abstract executeReport( Locale )</code> from: <ul> - <li>Mojo's execute() method (see maven-plugin-api)</li> - <li>MavenMultiPageReport's generate( Sink, SinkFactory, Locale ) (see maven-reporting-api)</li> - </ul> -<P> - -<P> -<DL> -<DT><B>Since:</B></DT> - <DD>2.0</DD> -<DT><B>Version:</B></DT> - <DD>$Id: AbstractMavenReport.java 1164275 2011-09-01 21:11:46Z hboutemy $</DD> -<DT><B>Author:</B></DT> - <DD><a href="eveni...@apache.org">Emmanuel Venisse</a></DD> -<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#execute()"><CODE>Mojo.execute() (from maven-plugin-api)</CODE></A>, -<A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.sink.SinkFactory, java.util.Locale)"><CODE>MavenMultiPageReport.generate( Sink, SinkFactory, Locale ) (from maven-reporting-api)</CODE></A>, -<A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#executeReport(java.util.Locale)"><CODE>abstract executeReport( Locale )</CODE></A></DL> -<HR> - -<P> -<!-- =========== 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> -</TABLE> - <A NAME="fields_inherited_from_class_org.apache.maven.reporting.MavenReport"><!-- --></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.reporting.<A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html" title="class or interface in org.apache.maven.reporting">MavenReport</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html#CATEGORY_PROJECT_INFORMATION" title="class or interface in org.apache.maven.reporting">CATEGORY_PROJECT_INFORMATION</A>, <A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html#CATEGORY_PROJECT_REPORTS" title="class or interface in org.apache.maven.reporting">CATEGORY_PROJECT_REPORTS</A>, <A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html#ROLE" title="class or interface in org.apache.maven.reporting">ROLE</A></CODE></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.<A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html" title="class or interface in org.apache.maven.plugin">Mojo</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html#ROLE" title="class or interface in org.apache.maven.plugin">ROLE</A></CODE></TD> -</TR> -</TABLE> - -<!-- ======== 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/reporting/AbstractMavenReport.html#AbstractMavenReport()">AbstractMavenReport</A></B>()</CODE> - -<BR> - </TD> -</TR> -</TABLE> - -<!-- ========== 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> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#canGenerateReport()">canGenerateReport</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#closeReport()">closeReport</A></B>()</CODE> - -<BR> - Actions when closing the report.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#execute()">execute</A></B>()</CODE> - -<BR> - This method is called when the report generation is invoked directly as a standalone Mojo.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected abstract void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#executeReport(java.util.Locale)">executeReport</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html" title="class or interface in java.util">Locale</A> locale)</CODE> - -<BR> - Execute the generation of the report.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.codehaus.doxia.sink.Sink, java.util.Locale)">generate</A></B>(<A HREF="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/codehaus/doxia/sink/Sink.html" title="class or interface in org.codehaus.doxia.sink">Sink</A> aSink, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html" title="class or interface in java.util">Locale</A> aLocale)</CODE> - -<BR> - <B>Deprecated.</B> <I>use <A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.sink.SinkFactory, java.util.Locale)"><CODE>generate(Sink, SinkFactory, Locale)</CODE></A> instead.</I></TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)">generate</A></B>(<A HREF="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html" title="class or interface in org.apache.maven.doxia.sink">Sink</A> aSink, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html" title="class or interface in java.util">Locale</A> aLocale)</CODE> - -<BR> - <B>Deprecated.</B> <I>use <A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.sink.SinkFactory, java.util.Locale)"><CODE>generate(Sink, SinkFactory, Locale)</CODE></A> instead.</I></TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.sink.SinkFactory, java.util.Locale)">generate</A></B>(<A HREF="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html" title="class or interface in org.apache.maven.doxia.sink">Sink</A> aSink, - <A HREF="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/SinkFactory.html" title="class or interface in org.apache.maven.doxia.sink">SinkFactory</A> aSinkFactory, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html" title="class or interface in java.util">Locale</A> aLocale)</CODE> - -<BR> - This method is called when the report generation is invoked by maven-site-plugin.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getCategoryName()">getCategoryName</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected abstract <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getOutputDirectory()">getOutputDirectory</A></B>()</CODE> - -<BR> - The output directory when the mojo is run directly from the command line.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected abstract <A HREF="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html" title="class or interface in org.apache.maven.project">MavenProject</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getProject()">getProject</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getReportOutputDirectory()">getReportOutputDirectory</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html" title="class or interface in org.apache.maven.doxia.sink">Sink</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getSink()">getSink</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/SinkFactory.html" title="class or interface in org.apache.maven.doxia.sink">SinkFactory</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getSinkFactory()">getSinkFactory</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected abstract <A HREF="http://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/apidocs/org/apache/maven/doxia/siterenderer/Renderer.html" title="class or interface in org.apache.maven.doxia.siterenderer">Renderer</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getSiteRenderer()">getSiteRenderer</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#isExternalReport()">isExternalReport</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#setReportOutputDirectory(java.io.File)">setReportOutputDirectory</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> reportOutputDirectory)</CODE> - -<BR> - </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.<A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html" title="class or interface in org.apache.maven.plugin">AbstractMojo</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html#getLog()" title="class or interface in org.apache.maven.plugin">getLog</A>, <A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html#getPluginContext()" title="class or interface in org.apache.maven.plugin">getPluginContext</A>, <A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html#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-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html#setPluginContext(java.util.Map)" title="class or interface in org.apache.maven.plugin">setPluginContext</A></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://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#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.reporting.MavenReport"><!-- --></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.reporting.<A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html" title="class or interface in org.apache.maven.reporting">MavenReport</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html#getDescription(java.util.Locale)" title="class or interface in org.apache.maven.reporting">getDescription</A>, <A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html#getName(java.util.Locale)" title="class or interface in org.apache.maven.reporting">getName</A>, <A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html#getOutputName()" title="class or interface in org.apache.maven.reporting">getOutputName</A></CODE></TD> -</TR> -</TABLE> - -<P> - -<!-- ========= 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="AbstractMavenReport()"><!-- --></A><H3> -AbstractMavenReport</H3> -<PRE> -public <B>AbstractMavenReport</B>()</PRE> -<DL> -</DL> - -<!-- ============ 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="execute()"><!-- --></A><H3> -execute</H3> -<PRE> -public void <B>execute</B>() - throws <A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoExecutionException.html" title="class or interface in org.apache.maven.plugin">MojoExecutionException</A></PRE> -<DL> -<DD>This method is called when the report generation is invoked directly as a standalone Mojo. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html#execute()" title="class or interface in org.apache.maven.plugin">execute</A></CODE> in interface <CODE><A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html" title="class or interface in org.apache.maven.plugin">Mojo</A></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoExecutionException.html" title="class or interface in org.apache.maven.plugin">MojoExecutionException</A></CODE> - if an error occurs when generating the report<DT><B>See Also:</B><DD><CODE>org.apache.maven.plugins.site.ReportDocumentRender</CODE>, -<A HREF="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html#execute()" title="class or interface in org.apache.maven.plugin"><CODE>Mojo.execute()</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="generate(org.codehaus.doxia.sink.Sink, java.util.Locale)"><!-- --></A><H3> -generate</H3> -<PRE> -public void <B>generate</B>(<A HREF="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/codehaus/doxia/sink/Sink.html" title="class or interface in org.codehaus.doxia.sink">Sink</A> aSink, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html" title="class or interface in java.util">Locale</A> aLocale) - throws <A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReportException.html" title="class or interface in org.apache.maven.reporting">MavenReportException</A></PRE> -<DL> -<DD><B>Deprecated.</B> <I>use <A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.sink.SinkFactory, java.util.Locale)"><CODE>generate(Sink, SinkFactory, Locale)</CODE></A> instead.</I> -<P> -<DD>Generate a report. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html#generate(org.codehaus.doxia.sink.Sink, java.util.Locale)" title="class or interface in org.apache.maven.reporting">generate</A></CODE> in interface <CODE><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html" title="class or interface in org.apache.maven.reporting">MavenReport</A></CODE></DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>aSink</CODE> - the sink to use for the generation.<DD><CODE>aLocale</CODE> - the wanted locale to generate the report, could be null. -<DT><B>Throws:</B> -<DD><CODE>MavenReportException</CODE> - if any</DL> -</DD> -</DL> -<HR> - -<A NAME="generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)"><!-- --></A><H3> -generate</H3> -<PRE> -public void <B>generate</B>(<A HREF="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html" title="class or interface in org.apache.maven.doxia.sink">Sink</A> aSink, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html" title="class or interface in java.util">Locale</A> aLocale) - throws <A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReportException.html" title="class or interface in org.apache.maven.reporting">MavenReportException</A></PRE> -<DL> -<DD><B>Deprecated.</B> <I>use <A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.sink.SinkFactory, java.util.Locale)"><CODE>generate(Sink, SinkFactory, Locale)</CODE></A> instead.</I> -<P> -<DD>Generate a report. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>aSink</CODE> - <DD><CODE>aLocale</CODE> - -<DT><B>Throws:</B> -<DD><CODE>MavenReportException</CODE><DT><B>See Also:</B><DD><CODE>org.apache.maven.reporting.MavenReport#generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)</CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="generate(org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.sink.SinkFactory, java.util.Locale)"><!-- --></A><H3> -generate</H3> -<PRE> -public void <B>generate</B>(<A HREF="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html" title="class or interface in org.apache.maven.doxia.sink">Sink</A> aSink, - <A HREF="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/SinkFactory.html" title="class or interface in org.apache.maven.doxia.sink">SinkFactory</A> aSinkFactory, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html" title="class or interface in java.util">Locale</A> aLocale) - throws <A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReportException.html" title="class or interface in org.apache.maven.reporting">MavenReportException</A></PRE> -<DL> -<DD>This method is called when the report generation is invoked by maven-site-plugin. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/maven/reporting/MavenMultiPageReport.html#generate(org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.sink.SinkFactory, java.util.Locale)">generate</A></CODE> in interface <CODE><A HREF="../../../../org/apache/maven/reporting/MavenMultiPageReport.html" title="interface in org.apache.maven.reporting">MavenMultiPageReport</A></CODE></DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>aSink</CODE> - <DD><CODE>aSinkFactory</CODE> - <DD><CODE>aLocale</CODE> - -<DT><B>Throws:</B> -<DD><CODE>MavenReportException</CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getCategoryName()"><!-- --></A><H3> -getCategoryName</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getCategoryName</B>()</PRE> -<DL> -<DD> -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html#getCategoryName()" title="class or interface in org.apache.maven.reporting">getCategoryName</A></CODE> in interface <CODE><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html" title="class or interface in org.apache.maven.reporting">MavenReport</A></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>CATEGORY_PROJECT_REPORTS</DL> -</DD> -</DL> -<HR> - -<A NAME="getReportOutputDirectory()"><!-- --></A><H3> -getReportOutputDirectory</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> <B>getReportOutputDirectory</B>()</PRE> -<DL> -<DD> -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html#getReportOutputDirectory()" title="class or interface in org.apache.maven.reporting">getReportOutputDirectory</A></CODE> in interface <CODE><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html" title="class or interface in org.apache.maven.reporting">MavenReport</A></CODE></DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="setReportOutputDirectory(java.io.File)"><!-- --></A><H3> -setReportOutputDirectory</H3> -<PRE> -public void <B>setReportOutputDirectory</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> reportOutputDirectory)</PRE> -<DL> -<DD> -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html#setReportOutputDirectory(java.io.File)" title="class or interface in org.apache.maven.reporting">setReportOutputDirectory</A></CODE> in interface <CODE><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html" title="class or interface in org.apache.maven.reporting">MavenReport</A></CODE></DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="closeReport()"><!-- --></A><H3> -closeReport</H3> -<PRE> -protected void <B>closeReport</B>()</PRE> -<DL> -<DD>Actions when closing the report. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getSink()"><!-- --></A><H3> -getSink</H3> -<PRE> -public <A HREF="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html" title="class or interface in org.apache.maven.doxia.sink">Sink</A> <B>getSink</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the sink used</DL> -</DD> -</DL> -<HR> - -<A NAME="getSinkFactory()"><!-- --></A><H3> -getSinkFactory</H3> -<PRE> -public <A HREF="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/SinkFactory.html" title="class or interface in org.apache.maven.doxia.sink">SinkFactory</A> <B>getSinkFactory</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the sink factory used</DL> -</DD> -</DL> -<HR> - -<A NAME="isExternalReport()"><!-- --></A><H3> -isExternalReport</H3> -<PRE> -public boolean <B>isExternalReport</B>()</PRE> -<DL> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html#isExternalReport()" title="class or interface in org.apache.maven.reporting">isExternalReport</A></CODE> in interface <CODE><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html" title="class or interface in org.apache.maven.reporting">MavenReport</A></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD><tt>false</tt> by default.<DT><B>See Also:</B><DD><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html#isExternalReport()" title="class or interface in org.apache.maven.reporting"><CODE>MavenReport.isExternalReport()</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="canGenerateReport()"><!-- --></A><H3> -canGenerateReport</H3> -<PRE> -public boolean <B>canGenerateReport</B>()</PRE> -<DL> -<DD> -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html#canGenerateReport()" title="class or interface in org.apache.maven.reporting">canGenerateReport</A></CODE> in interface <CODE><A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html" title="class or interface in org.apache.maven.reporting">MavenReport</A></CODE></DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getSiteRenderer()"><!-- --></A><H3> -getSiteRenderer</H3> -<PRE> -protected abstract <A HREF="http://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/apidocs/org/apache/maven/doxia/siterenderer/Renderer.html" title="class or interface in org.apache.maven.doxia.siterenderer">Renderer</A> <B>getSiteRenderer</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the site renderer used.</DL> -</DD> -</DL> -<HR> - -<A NAME="getOutputDirectory()"><!-- --></A><H3> -getOutputDirectory</H3> -<PRE> -protected abstract <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getOutputDirectory</B>()</PRE> -<DL> -<DD>The output directory when the mojo is run directly from the command line. Implementors should use this method to - return the value of a mojo parameter that the user may use to customize the output directory. - <br/> - <strong>Note:</strong> - When the mojo is run as part of a site generation, Maven will set the effective output directory via - <A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html#setReportOutputDirectory(java.io.File)" title="class or interface in org.apache.maven.reporting"><CODE>MavenReport.setReportOutputDirectory(java.io.File)</CODE></A>. In this case, the return - value of this method is irrelevant. Therefore, developers should always call <A HREF="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getReportOutputDirectory()"><CODE>getReportOutputDirectory()</CODE></A> - to get the effective output directory for the report. The later method will eventually fallback to this method - if the mojo is not run as part of a site generation. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The path to the output directory as specified in the plugin configuration for this report.</DL> -</DD> -</DL> -<HR> - -<A NAME="getProject()"><!-- --></A><H3> -getProject</H3> -<PRE> -protected abstract <A HREF="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html" title="class or interface in org.apache.maven.project">MavenProject</A> <B>getProject</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the Maven project instance.</DL> -</DD> -</DL> -<HR> - -<A NAME="executeReport(java.util.Locale)"><!-- --></A><H3> -executeReport</H3> -<PRE> -protected abstract void <B>executeReport</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html" title="class or interface in java.util">Locale</A> locale) - throws <A HREF="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReportException.html" title="class or interface in org.apache.maven.reporting">MavenReportException</A></PRE> -<DL> -<DD>Execute the generation of the report. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>locale</CODE> - the wanted locale to return the report's description, could be null. -<DT><B>Throws:</B> -<DD><CODE>MavenReportException</CODE> - if any</DL> -</DD> -</DL> -<!-- ========= 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/reporting/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/AbstractMavenReport.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"> - PREV CLASS - <A HREF="../../../../org/apache/maven/reporting/AbstractMavenReportRenderer.html" title="class in org.apache.maven.reporting"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/maven/reporting/AbstractMavenReport.html" target="_top"><B>FRAMES</B></A> - <A HREF="AbstractMavenReport.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- - if(window==top) { - document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); - } - //--> -</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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> -<!-- ======== END OF BOTTOM NAVBAR ======= --> - -<HR> -Copyright © 2002-2012 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. -</BODY> -</HTML> + <li>Mojo's <code>execute()</code> method, see maven-plugin-api</li> + <li>MavenMultiPageReport's <code>generate( Sink, SinkFactory, Locale )</code>, see maven-reporting-api</li> + </ul></div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd> +<dt><span class="strong">Version:</span></dt> + <dd>$Id: AbstractMavenReport.java 1624794 2014-09-14 00:30:58Z hboutemy $</dd> +<dt><span class="strong">Author:</span></dt> + <dd><a href="eveni...@apache.org">Emmanuel Venisse</a></dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#execute()"><code><code>Mojo.execute()</code>, from maven-plugin-api</code></a>, +<a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.apache.maven.doxia.sink.Sink,%20org.apache.maven.doxia.sink.SinkFactory,%20java.util.Locale)"><code><code>MavenMultiPageReport.generate( Sink, SinkFactory, Locale )</code>, + from maven-reporting-api</code></a>, +<a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#executeReport(java.util.Locale)"><code><code>abstract executeReport( Locale )</code></code></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="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://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></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#outputDirectory">outputDirectory</a></strong></code> +<div class="block">The output directory for the report.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected org.apache.maven.project.MavenProject</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#project">project</a></strong></code> +<div class="block">The Maven Project.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/apidocs/org/apache/maven/doxia/siterenderer/Renderer.html?is-external=true" title="class or interface in org.apache.maven.doxia.siterenderer">Renderer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#siteRenderer">siteRenderer</a></strong></code> +<div class="block">Doxia Site Renderer component.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.maven.reporting.MavenReport"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.maven.reporting.<a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a></h3> +<code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#CATEGORY_PROJECT_INFORMATION" title="class or interface in org.apache.maven.reporting">CATEGORY_PROJECT_INFORMATION</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#CATEGORY_PROJECT_REPORTS" title="class or interface in org.apache.maven.reporting">CATEGORY_PROJECT_REPORTS</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#ROLE" title="class or interface in org.apache.maven.reporting">ROLE</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.<a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">Mojo</a></h3> +<code><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true#ROLE" title="class or interface in org.apache.maven.plugin">ROLE</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="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/reporting/AbstractMavenReport.html#AbstractMavenReport()">AbstractMavenReport</a></strong>()</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="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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#canGenerateReport()">canGenerateReport</a></strong>()</code></td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#closeReport()">closeReport</a></strong>()</code> +<div class="block">Actions when closing the report.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#execute()">execute</a></strong>()</code> +<div class="block">This method is called when the report generation is invoked directly as a standalone Mojo.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#executeReport(java.util.Locale)">executeReport</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</code> +<div class="block">Execute the generation of the report.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.codehaus.doxia.sink.Sink,%20java.util.Locale)">generate</a></strong>(<a href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/codehaus/doxia/sink/Sink.html?is-external=true" title="class or interface in org.codehaus.doxia.sink">Sink</a> aSink, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> aLocale)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.apache.maven.doxia.sink.Sink,%20org.apache.maven.doxia.sink.SinkFactory,%20java.util.Locale)"><code>generate(Sink, SinkFactory, Locale)</code></a> instead.</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.apache.maven.doxia.sink.Sink,%20java.util.Locale)">generate</a></strong>(<a href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html?is-external=true" title="class or interface in org.apache.maven.doxia.sink">Sink</a> aSink, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> aLocale)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.apache.maven.doxia.sink.Sink,%20org.apache.maven.doxia.sink.SinkFactory,%20java.util.Locale)"><code>generate(Sink, SinkFactory, Locale)</code></a> instead.</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.apache.maven.doxia.sink.Sink,%20org.apache.maven.doxia.sink.SinkFactory,%20java.util.Locale)">generate</a></strong>(<a href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html?is-external=true" title="class or interface in org.apache.maven.doxia.sink">Sink</a> aSink, + <a href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/SinkFactory.html?is-external=true" title="class or interface in org.apache.maven.doxia.sink">SinkFactory</a> aSinkFactory, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> aLocale)</code> +<div class="block">This method is called when the report generation is invoked by maven-site-plugin.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getCategoryName()">getCategoryName</a></strong>()</code></td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getInputEncoding()">getInputEncoding</a></strong>()</code> +<div class="block">Gets the input files encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getOutputDirectory()">getOutputDirectory</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getOutputEncoding()">getOutputEncoding</a></strong>()</code> +<div class="block">Gets the effective reporting output files encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected org.apache.maven.project.MavenProject</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getProject()">getProject</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getReportOutputDirectory()">getReportOutputDirectory</a></strong>()</code></td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html?is-external=true" title="class or interface in org.apache.maven.doxia.sink">Sink</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getSink()">getSink</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/SinkFactory.html?is-external=true" title="class or interface in org.apache.maven.doxia.sink">SinkFactory</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getSinkFactory()">getSinkFactory</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/apidocs/org/apache/maven/doxia/siterenderer/Renderer.html?is-external=true" title="class or interface in org.apache.maven.doxia.siterenderer">Renderer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#getSiteRenderer()">getSiteRenderer</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#isExternalReport()">isExternalReport</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#setReportOutputDirectory(java.io.File)">setReportOutputDirectory</a></strong>(<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> reportOutputDirectory)</code></td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.maven.plugin.AbstractMojo"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.maven.plugin.<a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">AbstractMojo</a></h3> +<code><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#getLog()" title="class or interface in org.apache.maven.plugin">getLog</a>, <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#getPluginContext()" title="class or interface in org.apache.maven.plugin">getPluginContext</a>, <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#setLog(org.apache.maven.plugin.logging.Log)" title="class or interface in org.apache.maven.plugin">setLog</a>, <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#setPluginContext(java.util.Map)" title="class or interface in org.apache.maven.plugin">setPluginContext</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="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></h3> +<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/jav ase/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,%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.reporting.MavenReport"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.maven.reporting.<a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a></h3> +<code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#getDescription(java.util.Locale)" title="class or interface in org.apache.maven.reporting">getDescription</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#getName(java.util.Locale)" title="class or interface in org.apache.maven.reporting">getName</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#getOutputName()" title="class or interface in org.apache.maven.reporting">getOutputName</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="outputDirectory"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>outputDirectory</h4> +<pre><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#defaultValue()" title="class or interface in org.apache.maven.plugins.annotations">defaultValue</a>="${project.reporting.outputDirectory}", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#readonly()" title="class or interface in org.apache.maven.plugins.annotations">readonly</a>=true, + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#required()" title="class or interface in org.apache.maven.plugins.annotations">required</a>=true) +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> outputDirectory</pre> +<div class="block">The output directory for the report. Note that this parameter is only evaluated if the goal is run directly from + the command line. If the goal is run indirectly as part of a site generation, the output directory configured in + the Maven Site Plugin is used instead.</div> +</li> +</ul> +<a name="project"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>project</h4> +<pre><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#defaultValue()" title="class or interface in org.apache.maven.plugins.annotations">defaultValue</a>="${project}", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#readonly()" title="class or interface in org.apache.maven.plugins.annotations">readonly</a>=true, + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#required()" title="class or interface in org.apache.maven.plugins.annotations">required</a>=true) +protected org.apache.maven.project.MavenProject project</pre> +<div class="block">The Maven Project.</div> +</li> +</ul> +<a name="siteRenderer"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>siteRenderer</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Component.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Component</a> +protected <a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/apidocs/org/apache/maven/doxia/siterenderer/Renderer.html?is-external=true" title="class or interface in org.apache.maven.doxia.siterenderer">Renderer</a> siteRenderer</pre> +<div class="block">Doxia Site Renderer component.</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AbstractMavenReport()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractMavenReport</h4> +<pre>public AbstractMavenReport()</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="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>public void execute() + throws <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoExecutionException.html?is-external=true" title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></pre> +<div class="block">This method is called when the report generation is invoked directly as a standalone Mojo.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true#execute()" title="class or interface in org.apache.maven.plugin">execute</a></code> in interface <code><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">Mojo</a></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoExecutionException.html?is-external=true" title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></code> - if an error occurs when generating the report</dd><dt><span class="strong">See Also:</span></dt><dd><code>org.apache.maven.plugins.site.ReportDocumentRender</code>, +<a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true#execute()" title="class or interface in org.apache.maven.plugin"><code>Mojo.execute()</code></a></dd></dl> +</li> +</ul> +<a name="generate(org.codehaus.doxia.sink.Sink, java.util.Locale)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>generate</h4> +<pre>public void generate(<a href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/codehaus/doxia/sink/Sink.html?is-external=true" title="class or interface in org.codehaus.doxia.sink">Sink</a> aSink, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> aLocale) + throws <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReportException.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReportException</a></pre> +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.apache.maven.doxia.sink.Sink,%20org.apache.maven.doxia.sink.SinkFactory,%20java.util.Locale)"><code>generate(Sink, SinkFactory, Locale)</code></a> instead.</i></div> +<div class="block">Generate a report.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#generate(org.codehaus.doxia.sink.Sink,%20java.util.Locale)" title="class or interface in org.apache.maven.reporting">generate</a></code> in interface <code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>aSink</code> - the sink to use for the generation.</dd><dd><code>aLocale</code> - the wanted locale to generate the report, could be null.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>MavenReportException</code> - if any</dd></dl> +</li> +</ul> +<a name="generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>generate</h4> +<pre>public void generate(<a href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html?is-external=true" title="class or interface in org.apache.maven.doxia.sink">Sink</a> aSink, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> aLocale) + throws <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReportException.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReportException</a></pre> +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#generate(org.apache.maven.doxia.sink.Sink,%20org.apache.maven.doxia.sink.SinkFactory,%20java.util.Locale)"><code>generate(Sink, SinkFactory, Locale)</code></a> instead.</i></div> +<div class="block">Generate a report.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aSink</code> - </dd><dd><code>aLocale</code> - </dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>MavenReportException</code></dd><dt><span class="strong">See Also:</span></dt><dd><code>org.apache.maven.reporting.MavenReport#generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)</code></dd></dl> +</li> +</ul> +<a name="generate(org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.sink.SinkFactory, java.util.Locale)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>generate</h4> +<pre>public void generate(<a href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html?is-external=true" title="class or interface in org.apache.maven.doxia.sink">Sink</a> aSink, + <a href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/SinkFactory.html?is-external=true" title="class or interface in org.apache.maven.doxia.sink">SinkFactory</a> aSinkFactory, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> aLocale) + throws <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReportException.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReportException</a></pre> +<div class="block">This method is called when the report generation is invoked by maven-site-plugin.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/maven/reporting/MavenMultiPageReport.html#generate(org.apache.maven.doxia.sink.Sink,%20org.apache.maven.doxia.sink.SinkFactory,%20java.util.Locale)">generate</a></code> in interface <code><a href="../../../../org/apache/maven/reporting/MavenMultiPageReport.html" title="interface in org.apache.maven.reporting">MavenMultiPageReport</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>aSink</code> - </dd><dd><code>aSinkFactory</code> - </dd><dd><code>aLocale</code> - </dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>MavenReportException</code></dd></dl> +</li> +</ul> +<a name="getCategoryName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCategoryName</h4> +<pre>public <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> getCategoryName()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#getCategoryName()" title="class or interface in org.apache.maven.reporting">getCategoryName</a></code> in interface <code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>CATEGORY_PROJECT_REPORTS</dd></dl> +</li> +</ul> +<a name="getReportOutputDirectory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReportOutputDirectory</h4> +<pre>public <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> getReportOutputDirectory()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#getReportOutputDirectory()" title="class or interface in org.apache.maven.reporting">getReportOutputDirectory</a></code> in interface <code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a></code></dd> +</dl> +</li> +</ul> +<a name="setReportOutputDirectory(java.io.File)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReportOutputDirectory</h4> +<pre>public void setReportOutputDirectory(<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> reportOutputDirectory)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#setReportOutputDirectory(java.io.File)" title="class or interface in org.apache.maven.reporting">setReportOutputDirectory</a></code> in interface <code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a></code></dd> +</dl> +</li> +</ul> +<a name="getOutputDirectory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOutputDirectory</h4> +<pre>protected <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> getOutputDirectory()</pre> +</li> +</ul> +<a name="getProject()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProject</h4> +<pre>protected org.apache.maven.project.MavenProject getProject()</pre> +</li> +</ul> +<a name="getSiteRenderer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSiteRenderer</h4> +<pre>protected <a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/apidocs/org/apache/maven/doxia/siterenderer/Renderer.html?is-external=true" title="class or interface in org.apache.maven.doxia.siterenderer">Renderer</a> getSiteRenderer()</pre> +</li> +</ul> +<a name="getInputEncoding()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInputEncoding</h4> +<pre>protected <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> getInputEncoding()</pre> +<div class="block">Gets the input files encoding.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The input files encoding, never <code>null</code>.</dd></dl> +</li> +</ul> +<a name="getOutputEncoding()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOutputEncoding</h4> +<pre>protected <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> getOutputEncoding()</pre> +<div class="block">Gets the effective reporting output files encoding.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The effective reporting output file encoding, never <code>null</code>.</dd></dl> +</li> +</ul> +<a name="closeReport()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>closeReport</h4> +<pre>protected void closeReport()</pre> +<div class="block">Actions when closing the report.</div> +</li> +</ul> +<a name="getSink()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSink</h4> +<pre>public <a href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html?is-external=true" title="class or interface in org.apache.maven.doxia.sink">Sink</a> getSink()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the sink used</dd></dl> +</li> +</ul> +<a name="getSinkFactory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSinkFactory</h4> +<pre>public <a href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/SinkFactory.html?is-external=true" title="class or interface in org.apache.maven.doxia.sink">SinkFactory</a> getSinkFactory()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the sink factory used</dd></dl> +</li> +</ul> +<a name="isExternalReport()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isExternalReport</h4> +<pre>public boolean isExternalReport()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#isExternalReport()" title="class or interface in org.apache.maven.reporting">isExternalReport</a></code> in interface <code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd><tt>false</tt> by default.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#isExternalReport()" title="class or interface in org.apache.maven.reporting"><code>MavenReport.isExternalReport()</code></a></dd></dl> +</li> +</ul> +<a name="canGenerateReport()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canGenerateReport</h4> +<pre>public boolean canGenerateReport()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#canGenerateReport()" title="class or interface in org.apache.maven.reporting">canGenerateReport</a></code> in interface <code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a></code></dd> +</dl> +</li> +</ul> +<a name="executeReport(java.util.Locale)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>executeReport</h4> +<pre>protected abstract void executeReport(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale) + throws <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReportException.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReportException</a></pre> +<div class="block">Execute the generation of the report.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locale</code> - the wanted locale to return the report's description, could be <code>null</code>.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>MavenReportException</code> - if any</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><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/reporting/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractMavenReport.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>
[... 51 lines stripped ...]