blob: 343a641086d1415ec647b6c1f7f0a1be70a7e1b7 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (21) -->
<title>Uses of Package 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="use: package: org.apache.rat">
<meta name="generator" content="javadoc/PackageUseWriter">
<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-use-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">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</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</li>
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list"></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="Uses of Package org.apache.rat" class="title">Uses of Package<br>org.apache.rat</h1>
</div>
<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.rat</a></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="#org.apache.rat">org.apache.rat</a></div>
<div class="col-last even-row-color">
<div class="block">The base package for the RAT tool.</div>
</div>
<div class="col-first odd-row-color"><a href="#org.apache.rat.analysis">org.apache.rat.analysis</a></div>
<div class="col-last odd-row-color">
<div class="block">Classes that perform analyses of files.</div>
</div>
<div class="col-first even-row-color"><a href="#org.apache.rat.analysis.license">org.apache.rat.analysis.license</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.rat.anttasks">org.apache.rat.anttasks</a></div>
<div class="col-last odd-row-color">
<div class="block">The base package for the RAT Apache Ant Task Library.</div>
</div>
<div class="col-first even-row-color"><a href="#org.apache.rat.commandline">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="#org.apache.rat.configuration">org.apache.rat.configuration</a></div>
<div class="col-last odd-row-color">
<div class="block">Classes to process configuration information from/to files.</div>
</div>
<div class="col-first even-row-color"><a href="#org.apache.rat.documentation.options">org.apache.rat.documentation.options</a></div>
<div class="col-last even-row-color">
<div class="block">Contains ancillary enhanced options for the various RAT interfaces.</div>
</div>
<div class="col-first odd-row-color"><a href="#org.apache.rat.documentation.velocity">org.apache.rat.documentation.velocity</a></div>
<div class="col-last odd-row-color">
<div class="block">Contains velocity based tools and accessories.</div>
</div>
<div class="col-first even-row-color"><a href="#org.apache.rat.header">org.apache.rat.header</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.rat.help">org.apache.rat.help</a></div>
<div class="col-last odd-row-color">
<div class="block">Classes to output help and help like information.</div>
</div>
<div class="col-first even-row-color"><a href="#org.apache.rat.license">org.apache.rat.license</a></div>
<div class="col-last even-row-color">
<div class="block">Classes describing licenses</div>
</div>
<div class="col-first odd-row-color"><a href="#org.apache.rat.mp">org.apache.rat.mp</a></div>
<div class="col-last odd-row-color">
<div class="block">The base package for the RAT Maven plugin.</div>
</div>
<div class="col-first even-row-color"><a href="#org.apache.rat.report">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="#org.apache.rat.report.claim">org.apache.rat.report.claim</a></div>
<div class="col-last odd-row-color">
<div class="block">Classes that manage claims (metrics) about files and categories of files.</div>
</div>
<div class="col-first even-row-color"><a href="#org.apache.rat.report.xml">org.apache.rat.report.xml</a></div>
<div class="col-last even-row-color">
<div class="block">Classes that write the XML output.</div>
</div>
</div>
<section class="package-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.rat">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="package-summary.html">org.apache.rat</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/ConfigurationException.html#org.apache.rat">ConfigurationException</a></div>
<div class="col-last even-row-color">
<div class="block">An exception thrown when there is an issue with the configuration.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/Defaults.html#org.apache.rat">Defaults</a></div>
<div class="col-last odd-row-color">
<div class="block">A class that provides the standard system defaults for the ReportConfiguration.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/Defaults.Builder.html#org.apache.rat">Defaults.Builder</a></div>
<div class="col-last even-row-color">
<div class="block">The Defaults builder.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/ImplementationException.html#org.apache.rat">ImplementationException</a></div>
<div class="col-last odd-row-color">
<div class="block">An exception thrown when there is an issue with the implementation of an extension point.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/OptionCollection.ArgumentType.html#org.apache.rat">OptionCollection.ArgumentType</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="class-use/ReportConfiguration.html#org.apache.rat">ReportConfiguration</a></div>
<div class="col-last odd-row-color">
<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 even-row-color"><a href="class-use/ReportConfiguration.Processing.html#org.apache.rat">ReportConfiguration.Processing</a></div>
<div class="col-last even-row-color">
<div class="block">The styles of processing for various categories of documents.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.rat.analysis">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="analysis/package-summary.html">org.apache.rat.analysis</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/ReportConfiguration.html#org.apache.rat.analysis">ReportConfiguration</a></div>
<div class="col-last even-row-color">
<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>
</section>
</li>
<li>
<section class="detail" id="org.apache.rat.analysis.license">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="analysis/license/package-summary.html">org.apache.rat.analysis.license</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/DeprecationReporter.Info.html#org.apache.rat.analysis.license">DeprecationReporter.Info</a></div>
<div class="col-last even-row-color">
<div class="block">Annotation to provide deprecation information for Java8.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.rat.anttasks">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="anttasks/package-summary.html">org.apache.rat.anttasks</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/DeprecationReporter.Info.html#org.apache.rat.anttasks">DeprecationReporter.Info</a></div>
<div class="col-last even-row-color">
<div class="block">Annotation to provide deprecation information for Java8.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/ReportConfiguration.html#org.apache.rat.anttasks">ReportConfiguration</a></div>
<div class="col-last odd-row-color">
<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>
</section>
</li>
<li>
<section class="detail" id="org.apache.rat.commandline">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="commandline/package-summary.html">org.apache.rat.commandline</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/ConfigurationException.html#org.apache.rat.commandline">ConfigurationException</a></div>
<div class="col-last even-row-color">
<div class="block">An exception thrown when there is an issue with the configuration.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/ReportConfiguration.html#org.apache.rat.commandline">ReportConfiguration</a></div>
<div class="col-last odd-row-color">
<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>
</section>
</li>
<li>
<section class="detail" id="org.apache.rat.configuration">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="configuration/package-summary.html">org.apache.rat.configuration</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/ReportConfiguration.html#org.apache.rat.configuration">ReportConfiguration</a></div>
<div class="col-last even-row-color">
<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>
</section>
</li>
<li>
<section class="detail" id="org.apache.rat.documentation.options">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="documentation/options/package-summary.html">org.apache.rat.documentation.options</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/OptionCollection.ArgumentType.html#org.apache.rat.documentation.options">OptionCollection.ArgumentType</a></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.rat.documentation.velocity">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="documentation/velocity/package-summary.html">org.apache.rat.documentation.velocity</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/OptionCollection.ArgumentType.html#org.apache.rat.documentation.velocity">OptionCollection.ArgumentType</a></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.rat.header">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="header/package-summary.html">org.apache.rat.header</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/DeprecationReporter.Info.html#org.apache.rat.header">DeprecationReporter.Info</a></div>
<div class="col-last even-row-color">
<div class="block">Annotation to provide deprecation information for Java8.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.rat.help">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="help/package-summary.html">org.apache.rat.help</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/ReportConfiguration.html#org.apache.rat.help">ReportConfiguration</a></div>
<div class="col-last even-row-color">
<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"><a href="class-use/VersionInfo.html#org.apache.rat.help">VersionInfo</a></div>
<div class="col-last odd-row-color">
<div class="block">A formatter for Package information about a class.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.rat.license">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="license/package-summary.html">org.apache.rat.license</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/DeprecationReporter.Info.html#org.apache.rat.license">DeprecationReporter.Info</a></div>
<div class="col-last even-row-color">
<div class="block">Annotation to provide deprecation information for Java8.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.rat.mp">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="mp/package-summary.html">org.apache.rat.mp</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/Defaults.Builder.html#org.apache.rat.mp">Defaults.Builder</a></div>
<div class="col-last even-row-color">
<div class="block">The Defaults builder.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/ReportConfiguration.html#org.apache.rat.mp">ReportConfiguration</a></div>
<div class="col-last odd-row-color">
<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>
</section>
</li>
<li>
<section class="detail" id="org.apache.rat.report">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="report/package-summary.html">org.apache.rat.report</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/ReportConfiguration.html#org.apache.rat.report">ReportConfiguration</a></div>
<div class="col-last even-row-color">
<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>
</section>
</li>
<li>
<section class="detail" id="org.apache.rat.report.claim">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="report/claim/package-summary.html">org.apache.rat.report.claim</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/ReportConfiguration.html#org.apache.rat.report.claim">ReportConfiguration</a></div>
<div class="col-last even-row-color">
<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>
</section>
</li>
<li>
<section class="detail" id="org.apache.rat.report.xml">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat</a> used by <a href="report/xml/package-summary.html">org.apache.rat.report.xml</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/ReportConfiguration.html#org.apache.rat.report.xml">ReportConfiguration</a></div>
<div class="col-last even-row-color">
<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>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2006&#x2013;2025 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>