| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (21) --> |
| <title>Uses of Package org.apache.rat.api (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.api"> |
| <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"> </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</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.api" class="title">Uses of Package<br>org.apache.rat.api</h1> |
| </div> |
| <div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.rat.api</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.api">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.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.document">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">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">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.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.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 class="col-first odd-row-color"><a href="#org.apache.rat.walker">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> |
| <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.api</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/RatException.html#org.apache.rat">RatException</a></div> |
| <div class="col-last even-row-color"> </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.api</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/Document.html#org.apache.rat.analysis">Document</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The representation of a document being scanned.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="class-use/Document.Type.html#org.apache.rat.analysis">Document.Type</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">An enumeration of document types.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="org.apache.rat.api"> |
| <div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat.api</a> used by <a href="package-summary.html">org.apache.rat.api</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/Document.html#org.apache.rat.api">Document</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The representation of a document being scanned.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="class-use/Document.Type.html#org.apache.rat.api">Document.Type</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">An enumeration of document types.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="class-use/EnvVar.html#org.apache.rat.api">EnvVar</a></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><a href="class-use/MetaData.html#org.apache.rat.api">MetaData</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Data about the document under test.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="class-use/RatException.html#org.apache.rat.api">RatException</a></div> |
| <div class="col-last even-row-color"> </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.api</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/RatException.html#org.apache.rat.configuration">RatException</a></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="org.apache.rat.document"> |
| <div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat.api</a> used by <a href="../document/package-summary.html">org.apache.rat.document</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/Document.html#org.apache.rat.document">Document</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The representation of a document being scanned.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="org.apache.rat.document.guesser"> |
| <div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat.api</a> used by <a href="../document/guesser/package-summary.html">org.apache.rat.document.guesser</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/Document.html#org.apache.rat.document.guesser">Document</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The representation of a document being scanned.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="org.apache.rat.documentation"> |
| <div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat.api</a> used by <a href="../documentation/package-summary.html">org.apache.rat.documentation</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/RatException.html#org.apache.rat.documentation">RatException</a></div> |
| <div class="col-last even-row-color"> </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.api</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/EnvVar.html#org.apache.rat.documentation.velocity">EnvVar</a></div> |
| <div class="col-last even-row-color"> </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.api</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/Document.html#org.apache.rat.report">Document</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The representation of a document being scanned.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="class-use/RatException.html#org.apache.rat.report">RatException</a></div> |
| <div class="col-last odd-row-color"> </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.api</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/Document.html#org.apache.rat.report.claim">Document</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The representation of a document being scanned.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="class-use/Document.Type.html#org.apache.rat.report.claim">Document.Type</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">An enumeration of document types.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="class-use/MetaData.html#org.apache.rat.report.claim">MetaData</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Data about the document under test.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="class-use/RatException.html#org.apache.rat.report.claim">RatException</a></div> |
| <div class="col-last odd-row-color"> </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.api</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/Document.html#org.apache.rat.report.xml">Document</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The representation of a document being scanned.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="class-use/RatException.html#org.apache.rat.report.xml">RatException</a></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="org.apache.rat.walker"> |
| <div class="caption"><span>Classes in <a href="package-summary.html">org.apache.rat.api</a> used by <a href="../walker/package-summary.html">org.apache.rat.walker</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/Document.html#org.apache.rat.walker">Document</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The representation of a document being scanned.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="class-use/RatException.html#org.apache.rat.walker">RatException</a></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </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> |
