| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (21) --> |
| <title>org.apache.rat (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"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <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="package-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 class="nav-bar-cell1-rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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#package">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Package:</p> |
| <ul> |
| <li><a href="#package-description">Description</a></li> |
| <li><a href="#related-package-summary">Related Packages</a></li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <h1 title="Package org.apache.rat" class="title">Package org.apache.rat</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.rat</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">The base package for the RAT tool. |
| <p> |
| In general UIs will use OptionsCollection to get the list of supported options and then create an instance of |
| ReportConfiguration that is then passed to the Reporter for processing and report generation. |
| </p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="analysis/package-summary.html">org.apache.rat.analysis</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Classes that perform analyses of files.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="annotation/package-summary.html">org.apache.rat.annotation</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Classes that update the files</div> |
| </div> |
| <div class="col-first even-row-color"><a href="anttasks/package-summary.html">org.apache.rat.anttasks</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The base package for the RAT Apache Ant Task Library.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="api/package-summary.html">org.apache.rat.api</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Key abstractions.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="commandline/package-summary.html">org.apache.rat.commandline</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Helper classes for command line processing.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="config/package-summary.html">org.apache.rat.config</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Contains source code management / revision control information used during plugin runs.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="configuration/package-summary.html">org.apache.rat.configuration</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Classes to process configuration information from/to files.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="document/package-summary.html">org.apache.rat.document</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The definitions of Documents and their analysers.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="documentation/package-summary.html">org.apache.rat.documentation</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Contains tools for generating documentation.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="header/package-summary.html">org.apache.rat.header</a></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><a href="help/package-summary.html">org.apache.rat.help</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Classes to output help and help like information.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="license/package-summary.html">org.apache.rat.license</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Classes describing licenses</div> |
| </div> |
| <div class="col-first even-row-color"><a href="mp/package-summary.html">org.apache.rat.mp</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The base package for the RAT Maven plugin.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="plugin/package-summary.html">org.apache.rat.plugin</a></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><a href="report/package-summary.html">org.apache.rat.report</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Classes that generate the Rat report.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="tools/package-summary.html">org.apache.rat.tools</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Contains ancillary tools for the RAT program including code generators and name harmonization code.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="utils/package-summary.html">org.apache.rat.utils</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Classes with general utility across the project.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="walker/package-summary.html">org.apache.rat.walker</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Classes that walk directory trees and return documents.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enums</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exception Classes</button><button id="class-summary-tab6" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab6', 2)" class="table-tab">Annotation Types</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="BuilderParams.html" title="interface in org.apache.rat">BuilderParams</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Parameters that can be set by the BUILDER_PARAM ComponentType.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab5"><a href="ConfigurationException.html" title="class in org.apache.rat">ConfigurationException</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab5"> |
| <div class="block">An exception thrown when there is an issue with the configuration.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Defaults.html" title="class in org.apache.rat">Defaults</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A class that provides the standard system defaults for the ReportConfiguration.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Defaults.Builder.html" title="class in org.apache.rat">Defaults.Builder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">The Defaults builder.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DeprecationReporter.html" title="class in org.apache.rat">DeprecationReporter</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Reporting methods for deprecated objects.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab6"><a href="DeprecationReporter.Info.html" title="annotation in org.apache.rat">DeprecationReporter.Info</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab6"> |
| <div class="block">Annotation to provide deprecation information for Java8.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab5"><a href="ImplementationException.html" title="class in org.apache.rat">ImplementationException</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab5"> |
| <div class="block">An exception thrown when there is an issue with the implementation of an extension point.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="OptionCollection.html" title="class in org.apache.rat">OptionCollection</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">The collection of standard options for the CLI as well as utility methods to manage them and methods to create the |
| ReportConfiguration from the options and an array of arguments.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="OptionCollection.ArgumentType.html" title="enum in org.apache.rat">OptionCollection.ArgumentType</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Report.html" title="class in org.apache.rat">Report</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">The CLI based configuration object for report generation.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A configuration object is used by the front end to invoke the |
| <a href="Reporter.html" title="class in org.apache.rat"><code>Reporter</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ReportConfiguration.NoCloseOutputStream.html" title="class in org.apache.rat">ReportConfiguration.NoCloseOutputStream</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A wrapper around an output stream that does not close the output stream.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="ReportConfiguration.Processing.html" title="enum in org.apache.rat">ReportConfiguration.Processing</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> |
| <div class="block">The styles of processing for various categories of documents.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Reporter.html" title="class in org.apache.rat">Reporter</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <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> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="VersionInfo.html" title="class in org.apache.rat">VersionInfo</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A formatter for Package information about a class.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </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> |
