| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (21) --> |
| <title>Reporter (Apache Creadur RAT 0.17-SNAPSHOT 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, class: Reporter"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| <script type="text/javascript" src="../../../script-dir/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../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/Reporter.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#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li>Field</li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.rat</a></div> |
| <h1 title="Class Reporter" class="title">Class Reporter</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.rat.Reporter</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Reporter</span> |
| <span class="extends-implements">extends <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></span></div> |
| <div class="block">Class that executes the report as defined in a <a href="ReportConfiguration.html" title="class in org.apache.rat"><code>ReportConfiguration</code></a> and stores |
| the result for later handling.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.rat.ReportConfiguration)" class="member-name-link">Reporter</a><wbr>(<a href="ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a> configuration)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Create the reporter.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Executes the report and builds the output.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClaimsStatistic()" class="member-name-link">getClaimsStatistic</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the claim statistics from the run.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#listLicenses(org.apache.rat.ReportConfiguration,org.apache.rat.license.LicenseSetFactory.LicenseFilter)" class="member-name-link">listLicenses</a><wbr>(<a href="ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a> configuration, |
| <a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a> filter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Lists the licenses on the configured output stream.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#output()" class="member-name-link">output</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Outputs the report using the stylesheet and output specified in the configuration.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#output(org.apache.commons.io.function.IOSupplier,org.apache.commons.io.function.IOSupplier)" class="member-name-link">output</a><wbr>(org.apache.commons.io.function.IOSupplier<<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>> stylesheet, |
| org.apache.commons.io.function.IOSupplier<<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>> output)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Outputs the report to the specified output using the stylesheet.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#writeSummary(java.lang.Appendable)" class="member-name-link">writeSummary</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a> appendable)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Writes a text summary of issues with the run.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.rat.ReportConfiguration)"> |
| <h3>Reporter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Reporter</span><wbr><span class="parameters">(<a href="ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a> configuration)</span></div> |
| <div class="block">Create the reporter.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>configuration</code> - the configuration to use.</dd> |
| </dl> |
| </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"><a href="report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a></span> <span class="element-name">execute</span>() |
| throws <span class="exceptions"><a href="api/RatException.html" title="class in org.apache.rat.api">RatException</a></span></div> |
| <div class="block">Executes the report and builds the output. |
| This method will build the internal XML document if it does not already exist. |
| If this method or either of the <a href="#output()"><code>output()</code></a> methods have already been called this method will return |
| the previous results.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the claim statistics.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="api/RatException.html" title="class in org.apache.rat.api">RatException</a></code> - on error.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getClaimsStatistic()"> |
| <h3>getClaimsStatistic</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a></span> <span class="element-name">getClaimsStatistic</span>()</div> |
| <div class="block">Get the claim statistics from the run.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the claim statistics.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="output()"> |
| <h3>output</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a></span> <span class="element-name">output</span>() |
| throws <span class="exceptions"><a href="api/RatException.html" title="class in org.apache.rat.api">RatException</a></span></div> |
| <div class="block">Outputs the report using the stylesheet and output specified in the configuration.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the Claim statistic from the run.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="api/RatException.html" title="class in org.apache.rat.api">RatException</a></code> - on error.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="output(org.apache.commons.io.function.IOSupplier,org.apache.commons.io.function.IOSupplier)"> |
| <h3>output</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a></span> <span class="element-name">output</span><wbr><span class="parameters">(org.apache.commons.io.function.IOSupplier<<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>> stylesheet, |
| org.apache.commons.io.function.IOSupplier<<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>> output)</span> |
| throws <span class="exceptions"><a href="api/RatException.html" title="class in org.apache.rat.api">RatException</a></span></div> |
| <div class="block">Outputs the report to the specified output using the stylesheet. It is safe to call this method more than once |
| in order to generate multiple reports from the same run.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stylesheet</code> - the style sheet to use for XSLT formatting.</dd> |
| <dd><code>output</code> - the output stream to write to.</dd> |
| <dt>Returns:</dt> |
| <dd>the Claim statistic for the run.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="api/RatException.html" title="class in org.apache.rat.api">RatException</a></code> - on error.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="listLicenses(org.apache.rat.ReportConfiguration,org.apache.rat.license.LicenseSetFactory.LicenseFilter)"> |
| <h3>listLicenses</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">listLicenses</span><wbr><span class="parameters">(<a href="ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a> configuration, |
| <a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a> filter)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Lists the licenses on the configured output stream.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>configuration</code> - The configuration for the system</dd> |
| <dd><code>filter</code> - the license filter that specifies which licenses to output.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if PrintWriter can not be retrieved from configuration.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeSummary(java.lang.Appendable)"> |
| <h3>writeSummary</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">writeSummary</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a> appendable)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Writes a text summary of issues with the run.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>appendable</code> - the appendable to write to.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - on error.</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> |
