Google Git
Sign in
apache / creadur-site / HEAD / . / rat017 / apidocs / org / apache / rat / document / package-summary.html
blob: ef866f0e58503cb1c407cd66053e22940ecf8479 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (21) -->
<title>org.apache.rat.document (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.document">
<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">&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 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:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</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.document" class="title">Package org.apache.rat.document</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.rat.document</span></div>
<section class="package-description" id="package-description">
<div class="block">The definitions of Documents and their analysers.</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="../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="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>
</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-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></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-tab2"><a href="ArchiveEntryDocument.html" title="class in org.apache.rat.document">ArchiveEntryDocument</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A Document that wraps an Archive entry.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArchiveEntryName.html" title="class in org.apache.rat.document">ArchiveEntryName</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="DocumentAnalyser.html" title="interface in org.apache.rat.document">DocumentAnalyser</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Analyses Documents.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The name for a document.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DocumentName.Builder.html" title="class in org.apache.rat.document">DocumentName.Builder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The Builder for a DocumentName.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DocumentName.FSInfo.html" title="class in org.apache.rat.document">DocumentName.FSInfo</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The file system information needed to process document names.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Matches document names.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DocumentNameMatcher.DecomposeData.html" title="class in org.apache.rat.document">DocumentNameMatcher.DecomposeData</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Data from a <a href="DocumentNameMatcher.html#decompose(org.apache.rat.document.DocumentName)"><code>DocumentNameMatcher.decompose(DocumentName)</code></a> call.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DocumentNameMatcher.FileFilterPredicate.html" title="class in org.apache.rat.document">DocumentNameMatcher.FileFilterPredicate</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A DocumentName predicate that uses <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileFilter.html" title="class or interface in java.io" class="external-link"><code>FileFilter</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DocumentNameMatcher.MatchPatternsPredicate.html" title="class in org.apache.rat.document">DocumentNameMatcher.MatchPatternsPredicate</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A DocumentName predicate that uses <a href="../config/exclusion/plexus/MatchPatterns.html" title="class in org.apache.rat.config.exclusion.plexus"><code>MatchPatterns</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DocumentNameMatcher.NotPredicate.html" title="class in org.apache.rat.document">DocumentNameMatcher.NotPredicate</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A DocumentName predicate that reverses another DocumentNameMatcher.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="FileDocument.html" title="class in org.apache.rat.document">FileDocument</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Document wrapping a File object.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="IgnoredDocument.html" title="class in org.apache.rat.document">IgnoredDocument</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Document wrapping a File object that is ignored by rule.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="RatDocumentAnalysisException.html" title="class in org.apache.rat.document">RatDocumentAnalysisException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">&nbsp;</div>
</div>
</div>
</div>
</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>