| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>RatReportMojo (Apache Creadur RAT 0.17 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.rat.mp, class: RatReportMojo"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar.top"> |
| <div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar.top.firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/RatReportMojo.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="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip.navbar.top"> |
| <!-- --> |
| </span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.rat.mp</a></div> |
| <h1 title="Class RatReportMojo" class="title">Class RatReportMojo</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.maven.plugin.AbstractMojo |
| <div class="inheritance"><a href="../plugin/BaseRatMojo.html" title="class in org.apache.rat.plugin">org.apache.rat.plugin.BaseRatMojo</a> |
| <div class="inheritance"><a href="AbstractRatMojo.html" title="class in org.apache.rat.mp">org.apache.rat.mp.AbstractRatMojo</a> |
| <div class="inheritance">org.apache.rat.mp.RatReportMojo</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>org.apache.maven.plugin.ContextEnabled</code>, <code>org.apache.maven.plugin.Mojo</code>, <code>org.apache.maven.reporting.MavenMultiPageReport</code>, <code>org.apache.maven.reporting.MavenReport</code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Mojo(name="rat", |
| requiresDependencyResolution=TEST, |
| threadSafe=true) |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">RatReportMojo</span> |
| <span class="extends-implements">extends <a href="AbstractRatMojo.html" title="class in org.apache.rat.mp">AbstractRatMojo</a> |
| implements org.apache.maven.reporting.MavenMultiPageReport</span></div> |
| <div class="block">Generates a report with RAT's output.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field.summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#outputDirectory">outputDirectory</a></span></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The output directory for the report.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.maven.artifact.repository.ArtifactRepository></code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#remoteRepositories">remoteRepositories</a></span></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Remote repositories used for the project.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected org.apache.maven.execution.MavenSession</code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#session">session</a></span></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The local repository.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected org.apache.maven.doxia.siterenderer.Renderer</code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#siteRenderer">siteRenderer</a></span></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Doxia Site Renderer component.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected org.apache.maven.doxia.tools.SiteTool</code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#siteTool">siteTool</a></span></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">SiteTool.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields.inherited.from.class.org.apache.rat.mp.AbstractRatMojo">Fields inherited from class org.apache.rat.mp.<a href="AbstractRatMojo.html" title="class in org.apache.rat.mp">AbstractRatMojo</a></h3> |
| <code><a href="AbstractRatMojo.html#project">project</a>, <a href="AbstractRatMojo.html#skip">skip</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields.inherited.from.class.org.apache.rat.plugin.BaseRatMojo">Fields inherited from class org.apache.rat.plugin.<a href="../plugin/BaseRatMojo.html" title="class in org.apache.rat.plugin">BaseRatMojo</a></h3> |
| <code><a href="../plugin/BaseRatMojo.html#args">args</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields.inherited.from.class.org.apache.maven.reporting.MavenReport">Fields inherited from interface org.apache.maven.reporting.MavenReport</h3> |
| <code>CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE</code></div> |
| <div class="inherited-list"> |
| <h3 id="fields.inherited.from.class.org.apache.maven.plugin.Mojo">Fields inherited from interface org.apache.maven.plugin.Mojo</h3> |
| <code>ROLE</code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor.summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E()">RatReportMojo</a></span>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method.summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#canGenerateReport()">canGenerateReport</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#closeReport()">closeReport</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Actions when closing the report.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#execute()">execute</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">This method is called when the report generation is invoked directly as a |
| standalone Mojo.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#executeReport(java.util.Locale)">executeReport</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Writes the report to the Doxia sink.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table-tab4 method-summary-table"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#generate(org.apache.maven.doxia.sink.Sink,java.util.Locale)">generate</a></span>​(org.apache.maven.doxia.sink.Sink sink, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table-tab4 method-summary-table"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#generate(org.apache.maven.doxia.sink.Sink,org.apache.maven.doxia.sink.SinkFactory,java.util.Locale)"><code>generate(Sink, SinkFactory, Locale)</code></a> instead.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#generate(org.apache.maven.doxia.sink.Sink,org.apache.maven.doxia.sink.SinkFactory,java.util.Locale)">generate</a></span>​(org.apache.maven.doxia.sink.Sink sink, |
| org.apache.maven.doxia.sink.SinkFactory sinkFactory, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">This method is called when the report generation is invoked by |
| maven-site-plugin.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table-tab4 method-summary-table"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#generate(org.codehaus.doxia.sink.Sink,java.util.Locale)">generate</a></span>​(org.codehaus.doxia.sink.Sink sink, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table-tab4 method-summary-table"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#generate(org.apache.maven.doxia.sink.Sink,org.apache.maven.doxia.sink.SinkFactory,java.util.Locale)"><code>generate(Sink, SinkFactory, Locale)</code></a> instead.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getCategoryName()">getCategoryName</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getDescription(java.util.Locale)">getDescription</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the reports description.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getInputEncoding()">getInputEncoding</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Gets the input files encoding.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getName(java.util.Locale)">getName</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the reports name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getOutputDirectory()">getOutputDirectory</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getOutputEncoding()">getOutputEncoding</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Gets the effective reporting output files encoding.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getOutputName()">getOutputName</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the reports file name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getReportOutputDirectory()">getReportOutputDirectory</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>org.apache.maven.doxia.sink.Sink</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getSink()">getSink</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>org.apache.maven.doxia.sink.SinkFactory</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getSinkFactory()">getSinkFactory</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>protected org.apache.maven.doxia.siterenderer.Renderer</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getSiteRenderer()">getSiteRenderer</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#isExternalReport()">isExternalReport</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setReportOutputDirectory(java.io.File)">setReportOutputDirectory</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> reportOutputDirectory)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.org.apache.rat.mp.AbstractRatMojo">Methods inherited from class org.apache.rat.mp.<a href="AbstractRatMojo.html" title="class in org.apache.rat.mp">AbstractRatMojo</a></h3> |
| <code><a href="AbstractRatMojo.html#getConfiguration()">getConfiguration</a>, <a href="AbstractRatMojo.html#getDefaultsBuilder()">getDefaultsBuilder</a>, <a href="AbstractRatMojo.html#getProject()">getProject</a>, <a href="AbstractRatMojo.html#getValues(org.apache.rat.commandline.Arg)">getValues</a>, <a href="AbstractRatMojo.html#logLicenses(java.util.Collection)">logLicenses</a>, <a href="AbstractRatMojo.html#removeKey(org.apache.rat.commandline.Arg)">removeKey</a>, <a href="AbstractRatMojo.html#setAddDefaultLicenses(boolean)">setAddDefaultLicenses</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.org.apache.rat.plugin.BaseRatMojo">Methods inherited from class org.apache.rat.plugin.<a href="../plugin/BaseRatMojo.html" title="class in org.apache.rat.plugin">BaseRatMojo</a></h3> |
| <code><a href="../plugin/BaseRatMojo.html#addArg(java.lang.String,java.lang.String)">addArg</a>, <a href="../plugin/BaseRatMojo.html#addArg(java.lang.String,java.lang.String%5B%5D)">addArg</a>, <a href="../plugin/BaseRatMojo.html#args()">args</a>, <a href="../plugin/BaseRatMojo.html#createName(java.lang.String)">createName</a>, <a href="../plugin/BaseRatMojo.html#getArg(java.lang.String)">getArg</a>, <a href="../plugin/BaseRatMojo.html#removeArg(java.lang.String)">removeArg</a>, <a href="../plugin/BaseRatMojo.html#setAddLicense(boolean)">setAddLicense</a>, <a href="../plugin/BaseRatMojo.html#setArg(java.lang.String,java.lang.String)">setArg</a>, <a href="../plugin/BaseRatMojo.html#setConfig(java.lang.String)">setConfig</a>, <a href="../plugin/BaseRatMojo.html#setConfigs(java.lang.String%5B%5D)">setConfigs</a>, <a href="../plugin/BaseRatMojo.html#setConfigurationNoDefaults(boolean)">setConfigurationNoDefaults</a>, <a href="../plugin/BaseRatMojo.html#setCopyright(java.lang.String)">setCopyright</a>, <a href="../plugin/BaseRatMojo.html#setCounterMax(java.lang.String)">setCounterMax</a>, <a href="../plugin/BaseRatMojo.html#setCounterMaxs(java.lang.String%5B%5D)">setCounterMaxs</a>, <a href="../plugin/BaseRatMojo.html#setCounterMin(java.lang.String)">setCounterMin</a>, <a href="../plugin/BaseRatMojo.html#setCounterMins(java.lang.String%5B%5D)">setCounterMins</a>, <a href="../plugin/BaseRatMojo.html#setDryRun(boolean)">setDryRun</a>, <a href="../plugin/BaseRatMojo.html#setEditCopyright(java.lang.String)">setEditCopyright</a>, <a href="../plugin/BaseRatMojo.html#setEditLicense(boolean)">setEditLicense</a>, <a href="../plugin/BaseRatMojo.html#setEditOverwrite(boolean)">setEditOverwrite</a>, <a href="../plugin/BaseRatMojo.html#setExclude(java.lang.String)">setExclude</a>, <a href="../plugin/BaseRatMojo.html#setExcludeFile(java.lang.String)">setExcludeFile</a>, <a href="../plugin/BaseRatMojo.html#setExcludes(java.lang.String%5B%5D)">setExcludes</a>, <a href="../plugin/BaseRatMojo.html#setForce(boolean)">setForce</a>, <a href="../plugin/BaseRatMojo.html#setHelpLicenses(boolean)">setHelpLicenses</a>, <a href="../plugin/BaseRatMojo.html#setInclude(java.lang.String)">setInclude</a>, <a href="../plugin/BaseRatMojo.html#setIncludes(java.lang.String%5B%5D)">setIncludes</a>, <a href="../plugin/BaseRatMojo.html#setIncludesFile(java.lang.String)">setIncludesFile</a>, <a href="../plugin/BaseRatMojo.html#setInputExclude(java.lang.String)">setInputExclude</a>, <a href="../plugin/BaseRatMojo.html#setInputExcludeFile(java.lang.String)">setInputExcludeFile</a>, <a href="../plugin/BaseRatMojo.html#setInputExcludeParsedScm(java.lang.String)">setInputExcludeParsedScm</a>, <a href="../plugin/BaseRatMojo.html#setInputExcludeParsedScms(java.lang.String%5B%5D)">setInputExcludeParsedScms</a>, <a href="../plugin/BaseRatMojo.html#setInputExcludes(java.lang.String%5B%5D)">setInputExcludes</a>, <a href="../plugin/BaseRatMojo.html#setInputExcludeSize(java.lang.String)">setInputExcludeSize</a>, <a href="../plugin/BaseRatMojo.html#setInputExcludeStd(java.lang.String)">setInputExcludeStd</a>, <a href="../plugin/BaseRatMojo.html#setInputExcludeStds(java.lang.String%5B%5D)">setInputExcludeStds</a>, <a href="../plugin/BaseRatMojo.html#setInputInclude(java.lang.String)">setInputInclude</a>, <a href="../plugin/BaseRatMojo.html#setInputIncludeFile(java.lang.String)">setInputIncludeFile</a>, <a href="../plugin/BaseRatMojo.html#setInputIncludes(java.lang.String%5B%5D)">setInputIncludes</a>, <a href="../plugin/BaseRatMojo.html#setInputIncludeStd(java.lang.String)">setInputIncludeStd</a>, <a href="../plugin/BaseRatMojo.html#setInputIncludeStds(java.lang.String%5B%5D)">setInputIncludeStds</a>, <a href="../plugin/BaseRatMojo.html#setInputSource(java.lang.String)">setInputSource</a>, <a href="../plugin/BaseRatMojo.html#setInputSources(java.lang.String%5B%5D)">setInputSources</a>, <a href="../plugin/BaseRatMojo.html#setLicenseFamiliesApproved(java.lang.String)">setLicenseFamiliesApproved</a>, <a href="../plugin/BaseRatMojo.html#setLicenseFamiliesApprovedFile(java.lang.String)">setLicenseFamiliesApprovedFile</a>, <a href="../plugin/BaseRatMojo.html#setLicenseFamiliesDenied(java.lang.String)">setLicenseFamiliesDenied</a>, <a href="../plugin/BaseRatMojo.html#setLicenseFamiliesDeniedFile(java.lang.String)">setLicenseFamiliesDeniedFile</a>, <a href="../plugin/BaseRatMojo.html#setLicenses(java.lang.String)">setLicenses</a>, <a href="../plugin/BaseRatMojo.html#setLicenses(java.lang.String%5B%5D)">setLicenses</a>, <a href="../plugin/BaseRatMojo.html#setLicensesApproved(java.lang.String)">setLicensesApproved</a>, <a href="../plugin/BaseRatMojo.html#setLicensesApprovedFile(java.lang.String)">setLicensesApprovedFile</a>, <a href="../plugin/BaseRatMojo.html#setLicensesDenied(java.lang.String)">setLicensesDenied</a>, <a href="../plugin/BaseRatMojo.html#setLicensesDeniedFile(java.lang.String)">setLicensesDeniedFile</a>, <a href="../plugin/BaseRatMojo.html#setListFamilies(java.lang.String)">setListFamilies</a>, <a href="../plugin/BaseRatMojo.html#setListLicenses(java.lang.String)">setListLicenses</a>, <a href="../plugin/BaseRatMojo.html#setNoDefaultLicenses(boolean)">setNoDefaultLicenses</a>, <a href="../plugin/BaseRatMojo.html#setOut(java.lang.String)">setOut</a>, <a href="../plugin/BaseRatMojo.html#setOutputArchive(java.lang.String)">setOutputArchive</a>, <a href="../plugin/BaseRatMojo.html#setOutputFamilies(java.lang.String)">setOutputFamilies</a>, <a href="../plugin/BaseRatMojo.html#setOutputFile(java.lang.String)">setOutputFile</a>, <a href="../plugin/BaseRatMojo.html#setOutputLicenses(java.lang.String)">setOutputLicenses</a>, <a href="../plugin/BaseRatMojo.html#setOutputStandard(java.lang.String)">setOutputStandard</a>, <a href="../plugin/BaseRatMojo.html#setOutputStyle(java.lang.String)">setOutputStyle</a>, <a href="../plugin/BaseRatMojo.html#setScanHiddenDirectories(boolean)">setScanHiddenDirectories</a>, <a href="../plugin/BaseRatMojo.html#setStylesheet(java.lang.String)">setStylesheet</a>, <a href="../plugin/BaseRatMojo.html#setXml(boolean)">setXml</a>, <a href="../plugin/BaseRatMojo.html#toKebabForm(java.lang.String)">toKebabForm</a>, <a href="../plugin/BaseRatMojo.html#unsupportedArgs()">unsupportedArgs</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo">Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3> |
| <code>getLog, getPluginContext, setLog, setPluginContext</code></div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field.detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="outputDirectory"> |
| <h3>outputDirectory</h3> |
| <div class="member-signature"><span class="annotations">@Parameter(defaultValue="${project.reporting.outputDirectory}", |
| readonly=true, |
| required=true) |
| </span><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name">outputDirectory</span></div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="session"> |
| <h3>session</h3> |
| <div class="member-signature"><span class="annotations">@Parameter(defaultValue="${session}", |
| readonly=true, |
| required=true) |
| </span><span class="modifiers">protected</span> <span class="return-type">org.apache.maven.execution.MavenSession</span> <span class="element-name">session</span></div> |
| <div class="block">The local repository.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="remoteRepositories"> |
| <h3>remoteRepositories</h3> |
| <div class="member-signature"><span class="annotations">@Parameter(defaultValue="${project.remoteArtifactRepositories}", |
| readonly=true, |
| required=true) |
| </span><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.maven.artifact.repository.ArtifactRepository></span> <span class="element-name">remoteRepositories</span></div> |
| <div class="block">Remote repositories used for the project.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="siteTool"> |
| <h3>siteTool</h3> |
| <div class="member-signature"><span class="annotations">@Component |
| </span><span class="modifiers">protected</span> <span class="return-type">org.apache.maven.doxia.tools.SiteTool</span> <span class="element-name">siteTool</span></div> |
| <div class="block">SiteTool.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="siteRenderer"> |
| <h3>siteRenderer</h3> |
| <div class="member-signature"><span class="annotations">@Component |
| </span><span class="modifiers">protected</span> <span class="return-type">org.apache.maven.doxia.siterenderer.Renderer</span> <span class="element-name">siteRenderer</span></div> |
| <div class="block">Doxia Site Renderer component.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor.detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>RatReportMojo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">RatReportMojo</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="execute()"> |
| <h3>execute</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">execute</span>() |
| throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> |
| <div class="block">This method is called when the report generation is invoked directly as a |
| standalone Mojo.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>execute</code> in interface <code>org.apache.maven.plugin.Mojo</code></dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an error occurs when generating the report</dd> |
| <dt>See Also:</dt> |
| <dd><code>Mojo.execute()</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="generate(org.codehaus.doxia.sink.Sink,java.util.Locale)"> |
| <h3>generate</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">generate</span>​<span class="parameters">(org.codehaus.doxia.sink.Sink sink, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span> |
| throws <span class="exceptions">org.apache.maven.reporting.MavenReportException</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#generate(org.apache.maven.doxia.sink.Sink,org.apache.maven.doxia.sink.SinkFactory,java.util.Locale)"><code>generate(Sink, SinkFactory, Locale)</code></a> instead.</div> |
| </div> |
| <div class="block">Generate a report.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>generate</code> in interface <code>org.apache.maven.reporting.MavenReport</code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>sink</code> - the sink to use for the generation.</dd> |
| <dd><code>locale</code> - the wanted locale to generate the report, could be null.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.maven.reporting.MavenReportException</code> - if any</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="generate(org.apache.maven.doxia.sink.Sink,java.util.Locale)"> |
| <h3>generate</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">generate</span>​<span class="parameters">(org.apache.maven.doxia.sink.Sink sink, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span> |
| throws <span class="exceptions">org.apache.maven.reporting.MavenReportException</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#generate(org.apache.maven.doxia.sink.Sink,org.apache.maven.doxia.sink.SinkFactory,java.util.Locale)"><code>generate(Sink, SinkFactory, Locale)</code></a> instead.</div> |
| </div> |
| <div class="block">Generate a report.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sink</code> - the sink to use for the generation.</dd> |
| <dd><code>locale</code> - the wanted locale to generate the report, could be null.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.maven.reporting.MavenReportException</code> - if any</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="generate(org.apache.maven.doxia.sink.Sink,org.apache.maven.doxia.sink.SinkFactory,java.util.Locale)"> |
| <h3>generate</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">generate</span>​<span class="parameters">(org.apache.maven.doxia.sink.Sink sink, |
| org.apache.maven.doxia.sink.SinkFactory sinkFactory, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span> |
| throws <span class="exceptions">org.apache.maven.reporting.MavenReportException</span></div> |
| <div class="block">This method is called when the report generation is invoked by |
| maven-site-plugin.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>generate</code> in interface <code>org.apache.maven.reporting.MavenMultiPageReport</code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>sink</code> - the sink to use for the generation.</dd> |
| <dd><code>sinkFactory</code> - the sink factory to use for the generation.</dd> |
| <dd><code>locale</code> - the wanted locale to generate the report, could be null.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.maven.reporting.MavenReportException</code> - if any</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCategoryName()"> |
| <h3>getCategoryName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getCategoryName</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getCategoryName</code> in interface <code>org.apache.maven.reporting.MavenReport</code></dd> |
| <dt>Returns:</dt> |
| <dd>CATEGORY_PROJECT_REPORTS</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReportOutputDirectory()"> |
| <h3>getReportOutputDirectory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name">getReportOutputDirectory</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getReportOutputDirectory</code> in interface <code>org.apache.maven.reporting.MavenReport</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setReportOutputDirectory(java.io.File)"> |
| <h3>setReportOutputDirectory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setReportOutputDirectory</span>​<span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> reportOutputDirectory)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>setReportOutputDirectory</code> in interface <code>org.apache.maven.reporting.MavenReport</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOutputDirectory()"> |
| <h3>getOutputDirectory</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getOutputDirectory</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSiteRenderer()"> |
| <h3>getSiteRenderer</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.apache.maven.doxia.siterenderer.Renderer</span> <span class="element-name">getSiteRenderer</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInputEncoding()"> |
| <h3>getInputEncoding</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getInputEncoding</span>()</div> |
| <div class="block">Gets the input files encoding.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The input files encoding, never <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOutputEncoding()"> |
| <h3>getOutputEncoding</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getOutputEncoding</span>()</div> |
| <div class="block">Gets the effective reporting output files encoding.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The effective reporting output file encoding, never |
| <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="closeReport()"> |
| <h3>closeReport</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">closeReport</span>()</div> |
| <div class="block">Actions when closing the report.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSink()"> |
| <h3>getSink</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.maven.doxia.sink.Sink</span> <span class="element-name">getSink</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the sink used</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSinkFactory()"> |
| <h3>getSinkFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.maven.doxia.sink.SinkFactory</span> <span class="element-name">getSinkFactory</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the sink factory used</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isExternalReport()"> |
| <h3>isExternalReport</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isExternalReport</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>isExternalReport</code> in interface <code>org.apache.maven.reporting.MavenReport</code></dd> |
| <dt>Returns:</dt> |
| <dd><code>false</code> by default.</dd> |
| <dt>See Also:</dt> |
| <dd><code>MavenReport.isExternalReport()</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="canGenerateReport()"> |
| <h3>canGenerateReport</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">canGenerateReport</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>canGenerateReport</code> in interface <code>org.apache.maven.reporting.MavenReport</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="executeReport(java.util.Locale)"> |
| <h3>executeReport</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">executeReport</span>​<span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span> |
| throws <span class="exceptions">org.apache.maven.reporting.MavenReportException</span></div> |
| <div class="block">Writes the report to the Doxia sink.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>locale</code> - The locale to use for writing the report.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.maven.reporting.MavenReportException</code> - Writing the report failed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDescription(java.util.Locale)"> |
| <h3>getDescription</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getDescription</span>​<span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span></div> |
| <div class="block">Returns the reports description.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getDescription</code> in interface <code>org.apache.maven.reporting.MavenReport</code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>locale</code> - Requested locale of the bundle</dd> |
| <dt>Returns:</dt> |
| <dd>Report description, as given by the key "report.rat.description" in |
| the bundle.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getName(java.util.Locale)"> |
| <h3>getName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getName</span>​<span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span></div> |
| <div class="block">Returns the reports name.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getName</code> in interface <code>org.apache.maven.reporting.MavenReport</code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>locale</code> - Requested locale of the bundle</dd> |
| <dt>Returns:</dt> |
| <dd>Report name, as given by the key "report.rat.name" in the bundle.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOutputName()"> |
| <h3>getOutputName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getOutputName</span>()</div> |
| <div class="block">Returns the reports file name.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getOutputName</code> in interface <code>org.apache.maven.reporting.MavenReport</code></dd> |
| <dt>Returns:</dt> |
| <dd>"rat-report"</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2006–2025 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
