blob: cbabe846494c2e4f57a33279cb03abffc9dc3797 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (21) -->
<title>All Packages (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="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<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="all-packages-index-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>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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#all-packages">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="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
</div>
<div class="caption"><span>Package Summary</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/package-summary.html">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/package-summary.html">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/package-summary.html">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/analysis/matchers/package-summary.html">org.apache.rat.analysis.matchers</a></div>
<div class="col-last odd-row-color">
<div class="block">Classes that perform specific matching operations.</div>
</div>
<div class="col-first even-row-color"><a href="org/apache/rat/annotation/package-summary.html">org.apache.rat.annotation</a></div>
<div class="col-last even-row-color">
<div class="block">Classes that update the files</div>
</div>
<div class="col-first odd-row-color"><a href="org/apache/rat/anttasks/package-summary.html">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/api/package-summary.html">org.apache.rat.api</a></div>
<div class="col-last even-row-color">
<div class="block">Key abstractions.</div>
</div>
<div class="col-first odd-row-color"><a href="org/apache/rat/commandline/package-summary.html">org.apache.rat.commandline</a></div>
<div class="col-last odd-row-color">
<div class="block">Helper classes for command line processing.</div>
</div>
<div class="col-first even-row-color"><a href="org/apache/rat/config/package-summary.html">org.apache.rat.config</a></div>
<div class="col-last even-row-color">
<div class="block">Contains source code management / revision control information used during plugin runs.</div>
</div>
<div class="col-first odd-row-color"><a href="org/apache/rat/config/exclusion/package-summary.html">org.apache.rat.config.exclusion</a></div>
<div class="col-last odd-row-color">
<div class="block">Classes that manage the inclusion and exclusion of files.</div>
</div>
<div class="col-first even-row-color"><a href="org/apache/rat/config/exclusion/fileProcessors/package-summary.html">org.apache.rat.config.exclusion.fileProcessors</a></div>
<div class="col-last even-row-color">
<div class="block">Custom file processors to handles exclusions defined in various formats.</div>
</div>
<div class="col-first odd-row-color"><a href="org/apache/rat/config/exclusion/plexus/package-summary.html">org.apache.rat.config.exclusion.plexus</a></div>
<div class="col-last odd-row-color">
<div class="block">Code copied from https://github.com/codehaus-plexus/plexus-utils/ and modified for our purposes.</div>
</div>
<div class="col-first even-row-color"><a href="org/apache/rat/config/parameters/package-summary.html">org.apache.rat.config.parameters</a></div>
<div class="col-last even-row-color">
<div class="block">Classes that manage information about parameters for builders, matchers and similar components.</div>
</div>
<div class="col-first odd-row-color"><a href="org/apache/rat/config/results/package-summary.html">org.apache.rat.config.results</a></div>
<div class="col-last odd-row-color">
<div class="block">Contains utilities to validate the results.</div>
</div>
<div class="col-first even-row-color"><a href="org/apache/rat/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="org/apache/rat/configuration/builders/package-summary.html">org.apache.rat.configuration.builders</a></div>
<div class="col-last odd-row-color">
<div class="block">Classes to build matchers</div>
</div>
<div class="col-first even-row-color"><a href="org/apache/rat/document/package-summary.html">org.apache.rat.document</a></div>
<div class="col-last even-row-color">
<div class="block">The definitions of Documents and their analysers.</div>
</div>
<div class="col-first odd-row-color"><a href="org/apache/rat/document/guesser/package-summary.html">org.apache.rat.document.guesser</a></div>
<div class="col-last odd-row-color">
<div class="block">Classes that attempt to determine if a file is a specific type of file.</div>
</div>
<div class="col-first even-row-color"><a href="org/apache/rat/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="org/apache/rat/documentation/options/package-summary.html">org.apache.rat.documentation.options</a></div>
<div class="col-last odd-row-color">
<div class="block">Contains ancillary enhanced options for the various RAT interfaces.</div>
</div>
<div class="col-first even-row-color"><a href="org/apache/rat/documentation/velocity/package-summary.html">org.apache.rat.documentation.velocity</a></div>
<div class="col-last even-row-color">
<div class="block">Contains velocity based tools and accessories.</div>
</div>
<div class="col-first odd-row-color"><a href="org/apache/rat/header/package-summary.html">org.apache.rat.header</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="org/apache/rat/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="org/apache/rat/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="org/apache/rat/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="org/apache/rat/plugin/package-summary.html">org.apache.rat.plugin</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="org/apache/rat/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="org/apache/rat/report/claim/package-summary.html">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/package-summary.html">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 class="col-first odd-row-color"><a href="org/apache/rat/report/xml/writer/package-summary.html">org.apache.rat.report.xml.writer</a></div>
<div class="col-last odd-row-color">
<div class="block">Classes to handle writing well-formed XML documents.</div>
</div>
<div class="col-first even-row-color"><a href="org/apache/rat/tools/package-summary.html">org.apache.rat.tools</a></div>
<div class="col-last even-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 odd-row-color"><a href="org/apache/rat/tools/xsd/package-summary.html">org.apache.rat.tools.xsd</a></div>
<div class="col-last odd-row-color">
<div class="block">Contains XSD file generation tools.</div>
</div>
<div class="col-first even-row-color"><a href="org/apache/rat/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="org/apache/rat/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>
</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>