Google Git
Sign in
apache / creadur-site / HEAD / . / rat017 / apache-rat-tools / apidocs / index-all.html
blob: b170d8a6d254d3a6f14dc463fe54e8077f91ae22 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (21) -->
<title>Index (Apache Creadur RAT::Tools 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="index">
<meta name="generator" content="javadoc/IndexWriter">
<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="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 class="nav-bar-cell1-rev">Index</li>
<li><a href="help-doc.html#index">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>Index</h1>
</div>
<a href="#I:A">A</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:H">H</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:K">K</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:N">N</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:V">V</a>&nbsp;<a href="#I:W">W</a>&nbsp;<a href="#I:X">X</a>&nbsp;<br><a href="allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All&nbsp;Packages</a>
<h2 class="title" id="I:A">A</h2>
<dl class="index">
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html" class="type-name-link" title="class in org.apache.rat.documentation.options">AbstractOption</a> - Class in <a href="org/apache/rat/documentation/options/package-summary.html">org.apache.rat.documentation.options</a></dt>
<dd>
<div class="block">Abstract class that provides the framework for UI-specific RAT options.</div>
</dd>
<dt><a href="org/apache/rat/tools/AntDocumentation.html" class="type-name-link" title="class in org.apache.rat.tools">AntDocumentation</a> - Class in <a href="org/apache/rat/tools/package-summary.html">org.apache.rat.tools</a></dt>
<dd>
<div class="block">A simple tool to convert CLI options into an Ant report base class.</div>
</dd>
<dt><a href="org/apache/rat/tools/AntGenerator.html" class="type-name-link" title="class in org.apache.rat.tools">AntGenerator</a> - Class in <a href="org/apache/rat/tools/package-summary.html">org.apache.rat.tools</a></dt>
<dd>
<div class="block">A simple tool to convert CLI options into an Ant report base class.</div>
</dd>
<dt><a href="org/apache/rat/tools/AntGenerator.GenerateType.html" class="type-name-link" title="class in org.apache.rat.tools">AntGenerator.GenerateType</a> - Class in <a href="org/apache/rat/tools/package-summary.html">org.apache.rat.tools</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html" class="type-name-link" title="class in org.apache.rat.documentation.options">AntOption</a> - Class in <a href="org/apache/rat/documentation/options/package-summary.html">org.apache.rat.documentation.options</a></dt>
<dd>
<div class="block">A class that wraps the CLI option and provides Ant specific values.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html#%3Cinit%3E(org.apache.commons.cli.Option)" class="member-name-link">AntOption(Option)</a> - Constructor for class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.ExampleGenerator.html" class="type-name-link" title="class in org.apache.rat.documentation.options">AntOption.ExampleGenerator</a> - Class in <a href="org/apache/rat/documentation/options/package-summary.html">org.apache.rat.documentation.options</a></dt>
<dd>
<div class="block">An example code generator for this AntOption.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#antOptions()" class="member-name-link">antOptions()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Gets a map client option name to Ant Option.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#aptEscape(java.lang.String)" class="member-name-link">aptEscape(String)</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Escapes a string for APT (almost plain text).</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#argCount()" class="member-name-link">argCount()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Returns the number of arguments.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#argumentType" class="member-name-link">argumentType</a> - Variable in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">The argument type for this option</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#argumentTypes()" class="member-name-link">argumentTypes()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Gets the list of argument types.</div>
</dd>
<dt><a href="org/apache/rat/tools/ArgumentTypes.html" class="type-name-link" title="class in org.apache.rat.tools">ArgumentTypes</a> - Class in <a href="org/apache/rat/tools/package-summary.html">org.apache.rat.tools</a></dt>
<dd>
<div class="block">A simple tool to convert CLI options to Maven and Ant format and produce a CSV file.</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.html#attribute(java.lang.String,java.lang.String...)" class="member-name-link">attribute(String, String...)</a> - Method in class org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.html" title="class in org.apache.rat.tools.xsd">XsdWriter</a></dt>
<dd>
<div class="block">Writes the attributes</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.Type.html#ATTRIBUTE" class="member-name-link">ATTRIBUTE</a> - Enum constant in enum org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.Type.html" title="enum in org.apache.rat.tools.xsd">XsdWriter.Type</a></dt>
<dd>
<div class="block">An attribute</div>
</dd>
</dl>
<h2 class="title" id="I:C">C</h2>
<dl class="index">
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.Type.html#CHOICE" class="member-name-link">CHOICE</a> - Enum constant in enum org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.Type.html" title="enum in org.apache.rat.tools.xsd">XsdWriter.Type</a></dt>
<dd>
<div class="block">A choice</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#cleanup(java.lang.String)" class="member-name-link">cleanup(String)</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Replaces CLI pattern options with implementation specific pattern options.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#cleanupName()" class="member-name-link">cleanupName()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Gets this option's cleaned up name.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#cleanupName(org.apache.commons.cli.Option)" class="member-name-link">cleanupName(Option)</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Provide means to wrap the given option depending on the UI-specific option implementation.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html#cleanupName(org.apache.commons.cli.Option)" class="member-name-link">cleanupName(Option)</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/CLIOption.html#cleanupName(org.apache.commons.cli.Option)" class="member-name-link">cleanupName(Option)</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/CLIOption.html" title="class in org.apache.rat.documentation.options">CLIOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/MavenOption.html#cleanupName(org.apache.commons.cli.Option)" class="member-name-link">cleanupName(Option)</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/MavenOption.html" title="class in org.apache.rat.documentation.options">MavenOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/CLIOption.html" class="type-name-link" title="class in org.apache.rat.documentation.options">CLIOption</a> - Class in <a href="org/apache/rat/documentation/options/package-summary.html">org.apache.rat.documentation.options</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/CLIOption.html#%3Cinit%3E(org.apache.commons.cli.Option)" class="member-name-link">CLIOption(Option)</a> - Constructor for class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/CLIOption.html" title="class in org.apache.rat.documentation.options">CLIOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#cliOptions()" class="member-name-link">cliOptions()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Gets a map client option name to CLI Option.</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.html#close(org.apache.rat.tools.xsd.XsdWriter.Type)" class="member-name-link">close(XsdWriter.Type)</a> - Method in class org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.html" title="class in org.apache.rat.tools.xsd">XsdWriter</a></dt>
<dd>
<div class="block">Closes (Ends) the element for the type.</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.Type.html#COMPLEX" class="member-name-link">COMPLEX</a> - Enum constant in enum org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.Type.html" title="enum in org.apache.rat.tools.xsd">XsdWriter.Type</a></dt>
<dd>
<div class="block">A complex type</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.Type.html#COMPLEX_CONTENT" class="member-name-link">COMPLEX_CONTENT</a> - Enum constant in enum org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.Type.html" title="enum in org.apache.rat.tools.xsd">XsdWriter.Type</a></dt>
<dd>
<div class="block">A complex type</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html#convertedFrom()" class="member-name-link">convertedFrom()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>
<div class="block">Gets the set of options that are mapped to this option.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html#createName(org.apache.commons.cli.Option)" class="member-name-link">createName(Option)</a> - Static method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/CLIOption.html#createName(org.apache.commons.cli.Option)" class="member-name-link">createName(Option)</a> - Static method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/CLIOption.html" title="class in org.apache.rat.documentation.options">CLIOption</a></dt>
<dd>&nbsp;</dd>
</dl>
<h2 class="title" id="I:D">D</h2>
<dl class="index">
<dt><a href="org/apache/rat/tools/Documentation.html" class="type-name-link" title="class in org.apache.rat.tools">Documentation</a> - Class in <a href="org/apache/rat/tools/package-summary.html">org.apache.rat.tools</a></dt>
<dd>
<div class="block">Generates text based documentation for Licenses, LicenceFamilies, and Matchers.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#doubleLine()" class="member-name-link">doubleLine()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Gets two new lines.</div>
</dd>
</dl>
<h2 class="title" id="I:E">E</h2>
<dl class="index">
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.Type.html#ELEMENT" class="member-name-link">ELEMENT</a> - Enum constant in enum org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.Type.html" title="enum in org.apache.rat.tools.xsd">XsdWriter.Type</a></dt>
<dd>
<div class="block">An element</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#environmentVariables()" class="member-name-link">environmentVariables()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Gets the list of environment variables.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.ExampleGenerator.html#%3Cinit%3E()" class="member-name-link">ExampleGenerator()</a> - Constructor for class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.ExampleGenerator.html" title="class in org.apache.rat.documentation.options">AntOption.ExampleGenerator</a></dt>
<dd>
<div class="block">The constructor.</div>
</dd>
<dt><a href="org/apache/rat/tools/AntDocumentation.html#execute()" class="member-name-link">execute()</a> - Method in class org.apache.rat.tools.<a href="org/apache/rat/tools/AntDocumentation.html" title="class in org.apache.rat.tools">AntDocumentation</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/Exporter.html" class="type-name-link" title="class in org.apache.rat.documentation">Exporter</a> - Class in <a href="org/apache/rat/documentation/package-summary.html">org.apache.rat.documentation</a></dt>
<dd>
<div class="block">Uses Apache Velocity to write a document containing RAT configuration information.</div>
</dd>
<dt><a href="org/apache/rat/documentation/Exporter.html#%3Cinit%3E()" class="member-name-link">Exporter()</a> - Constructor for class org.apache.rat.documentation.<a href="org/apache/rat/documentation/Exporter.html" title="class in org.apache.rat.documentation">Exporter</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.Type.html#EXTENSION" class="member-name-link">EXTENSION</a> - Enum constant in enum org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.Type.html" title="enum in org.apache.rat.tools.xsd">XsdWriter.Type</a></dt>
<dd>
<div class="block">An extension</div>
</dd>
</dl>
<h2 class="title" id="I:F">F</h2>
<dl class="index">
<dt><a href="org/apache/rat/documentation/velocity/License.html#family()" class="member-name-link">family()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/License.html" title="class in org.apache.rat.documentation.velocity">License</a></dt>
<dd>
<div class="block">Gets the family name of this license.</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.html#finish()" class="member-name-link">finish()</a> - Method in class org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.html" title="class in org.apache.rat.tools.xsd">XsdWriter</a></dt>
<dd>
<div class="block">Finishes the process.</div>
</dd>
</dl>
<h2 class="title" id="I:G">G</h2>
<dl class="index">
<dt><a href="org/apache/rat/documentation/options/AntOption.html#getActualAntOption()" class="member-name-link">getActualAntOption()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>
<div class="block">If this option is converted to another option return that option otherwise
return this option.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html#getAntOptions()" class="member-name-link">getAntOptions()</a> - Static method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>
<div class="block">Gets the list of all available Ant options.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#getArgName()" class="member-name-link">getArgName()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Gets the argument name if there is one.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#getArgType()" class="member-name-link">getArgType()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Gets the argument type if there is one.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html#getAttributeFunctionName()" class="member-name-link">getAttributeFunctionName()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>
<div class="block">Get the signature of the attribute function.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.html#getAttributes()" class="member-name-link">getAttributes()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/Matcher.html" title="class in org.apache.rat.documentation.velocity">Matcher</a></dt>
<dd>
<div class="block">Gets the attributes of this matcher.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/MatcherTree.Node.html#getAttributes()" class="member-name-link">getAttributes()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/MatcherTree.Node.html" title="class in org.apache.rat.documentation.velocity">MatcherTree.Node</a></dt>
<dd>
<div class="block">Gets the attributes only if they have values.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.ExampleGenerator.html#getChildElements(java.lang.String,java.util.List)" class="member-name-link">getChildElements(String, List&lt;String&gt;)</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.ExampleGenerator.html" title="class in org.apache.rat.documentation.options">AntOption.ExampleGenerator</a></dt>
<dd>
<div class="block">Creates a string comprising the child elements for the Ant XML report call.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.Enclosed.html#getCollection()" class="member-name-link">getCollection()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/Matcher.Enclosed.html" title="class in org.apache.rat.documentation.velocity">Matcher.Enclosed</a></dt>
<dd>
<div class="block">Gets the phrase "or more " if the enclosed matcher may be multiple.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html#getComment(boolean)" class="member-name-link">getComment(boolean)</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>
<div class="block">Get the method comment for this option.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#getDefaultValue()" class="member-name-link">getDefaultValue()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Return default value.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/MavenOption.html#getDefaultValue()" class="member-name-link">getDefaultValue()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/MavenOption.html" title="class in org.apache.rat.documentation.options">MavenOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#getDeprecated()" class="member-name-link">getDeprecated()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Gets the deprecated string if the option is deprecated, or an empty string otherwise.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#getDescription()" class="member-name-link">getDescription()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Gets the description in implementation specific format.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.Attribute.html#getDescription()" class="member-name-link">getDescription()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/Matcher.Attribute.html" title="class in org.apache.rat.documentation.velocity">Matcher.Attribute</a></dt>
<dd>
<div class="block">Gets the description of the attribute or an empty string.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.html#getDescription()" class="member-name-link">getDescription()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/Matcher.html" title="class in org.apache.rat.documentation.velocity">Matcher</a></dt>
<dd>
<div class="block">Gets the description of the matcher type.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.html#getEnclosed()" class="member-name-link">getEnclosed()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/Matcher.html" title="class in org.apache.rat.documentation.velocity">Matcher</a></dt>
<dd>
<div class="block">If the matcher encloses another matcher return the definition of that enclosure.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/MatcherTree.Node.html#getEnclosed()" class="member-name-link">getEnclosed()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/MatcherTree.Node.html" title="class in org.apache.rat.documentation.velocity">MatcherTree.Node</a></dt>
<dd>
<div class="block">Gets the enclosed node only if it is another matcher.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#getExample()" class="member-name-link">getExample()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Gets an example of how to use this option in the native UI.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html#getExample()" class="member-name-link">getExample()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/CLIOption.html#getExample()" class="member-name-link">getExample()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/CLIOption.html" title="class in org.apache.rat.documentation.options">CLIOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/MavenOption.html#getExample()" class="member-name-link">getExample()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/MavenOption.html" title="class in org.apache.rat.documentation.options">MavenOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.ExampleGenerator.html#getExample(java.lang.String,java.util.Map,java.util.List)" class="member-name-link">getExample(String, Map&lt;String, String&gt;, List&lt;String&gt;)</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.ExampleGenerator.html" title="class in org.apache.rat.documentation.options">AntOption.ExampleGenerator</a></dt>
<dd>
<div class="block">Gets an example Ant XML report call using ant option with the specified attributes and child elements.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.ExampleGenerator.html#getExampleAttributes(java.lang.String,java.util.Map)" class="member-name-link">getExampleAttributes(String, Map&lt;String, String&gt;)</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.ExampleGenerator.html" title="class in org.apache.rat.documentation.options">AntOption.ExampleGenerator</a></dt>
<dd>
<div class="block">Creates a string comprising the attributes for the Ant XML report call.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html#getFilteredOptions()" class="member-name-link">getFilteredOptions()</a> - Static method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>
<div class="block">Gets the set of options that are not supported by Ant either by not being supported or
by being converted to another argument.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/MavenOption.html#getFilteredOptions()" class="member-name-link">getFilteredOptions()</a> - Static method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/MavenOption.html" title="class in org.apache.rat.documentation.options">MavenOption</a></dt>
<dd>
<div class="block">Gets the set of options that are not supported by Maven.</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdGenerator.html#getInputStream()" class="member-name-link">getInputStream()</a> - Method in class org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdGenerator.html" title="class in org.apache.rat.tools.xsd">XsdGenerator</a></dt>
<dd>
<div class="block">Create an input stream from the output of the generator.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/License.html#getMatcher()" class="member-name-link">getMatcher()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/License.html" title="class in org.apache.rat.documentation.velocity">License</a></dt>
<dd>
<div class="block">Gets the matcher associated with this license.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/License.html#getMatcherTree()" class="member-name-link">getMatcherTree()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/License.html" title="class in org.apache.rat.documentation.velocity">License</a></dt>
<dd>
<div class="block">Gets the matcher tree associated with this license.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/MavenOption.html#getMavenOptions()" class="member-name-link">getMavenOptions()</a> - Static method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/MavenOption.html" title="class in org.apache.rat.documentation.options">MavenOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/tools/AntGenerator.GenerateType.html#getMethodFormat(org.apache.rat.documentation.options.AntOption)" class="member-name-link">getMethodFormat(AntOption)</a> - Method in class org.apache.rat.tools.<a href="org/apache/rat/tools/AntGenerator.GenerateType.html" title="class in org.apache.rat.tools">AntGenerator.GenerateType</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/MavenOption.html#getMethodSignature(java.lang.String,boolean)" class="member-name-link">getMethodSignature(String, boolean)</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/MavenOption.html" title="class in org.apache.rat.documentation.options">MavenOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#getName()" class="member-name-link">getName()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Gets the implementation specific name for the CLI option.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.Attribute.html#getName()" class="member-name-link">getName()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/Matcher.Attribute.html" title="class in org.apache.rat.documentation.velocity">Matcher.Attribute</a></dt>
<dd>
<div class="block">Gets the attribute name.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.html#getName()" class="member-name-link">getName()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/Matcher.html" title="class in org.apache.rat.documentation.velocity">Matcher</a></dt>
<dd>
<div class="block">Get the name of the matcher type.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#getOption()" class="member-name-link">getOption()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Gets the option this abstract option is wrapping.</div>
</dd>
<dt><a href="org/apache/rat/tools/AntGenerator.GenerateType.html#getPattern(org.apache.rat.documentation.options.AntOption,org.apache.rat.documentation.options.AntOption)" class="member-name-link">getPattern(AntOption, AntOption)</a> - Method in class org.apache.rat.tools.<a href="org/apache/rat/tools/AntGenerator.GenerateType.html" title="class in org.apache.rat.tools">AntGenerator.GenerateType</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/MavenOption.html#getPropertyAnnotation(java.lang.String)" class="member-name-link">getPropertyAnnotation(String)</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/MavenOption.html" title="class in org.apache.rat.documentation.options">MavenOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html#getRenameMap()" class="member-name-link">getRenameMap()</a> - Static method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/MavenOption.html#getRenameMap()" class="member-name-link">getRenameMap()</a> - Static method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/MavenOption.html" title="class in org.apache.rat.documentation.options">MavenOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.Attribute.html#getRequired()" class="member-name-link">getRequired()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/Matcher.Attribute.html" title="class in org.apache.rat.documentation.velocity">Matcher.Attribute</a></dt>
<dd>
<div class="block">Gets the required flag.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.Enclosed.html#getRequired()" class="member-name-link">getRequired()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/Matcher.Enclosed.html" title="class in org.apache.rat.documentation.velocity">Matcher.Enclosed</a></dt>
<dd>
<div class="block">Gets the required flag.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/MatcherTree.html#getRoot()" class="member-name-link">getRoot()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/MatcherTree.html" title="class in org.apache.rat.documentation.velocity">MatcherTree</a></dt>
<dd>
<div class="block">Gets the description of the root of the tree.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#getText()" class="member-name-link">getText()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">return a string showing long and short options if they are available.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html#getText()" class="member-name-link">getText()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/CLIOption.html#getText()" class="member-name-link">getText()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/CLIOption.html" title="class in org.apache.rat.documentation.options">CLIOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/MavenOption.html#getText()" class="member-name-link">getText()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/MavenOption.html" title="class in org.apache.rat.documentation.options">MavenOption</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#getType()" class="member-name-link">getType()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Gets the simple class name for the data type for this option.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.Attribute.html#getType()" class="member-name-link">getType()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/Matcher.Attribute.html" title="class in org.apache.rat.documentation.velocity">Matcher.Attribute</a></dt>
<dd>
<div class="block">Get the type of the attribute.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.Enclosed.html#getType()" class="member-name-link">getType()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/Matcher.Enclosed.html" title="class in org.apache.rat.documentation.velocity">Matcher.Enclosed</a></dt>
<dd>
<div class="block">Get the type of the enclosed matcher.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html#getUnsupportedOptions()" class="member-name-link">getUnsupportedOptions()</a> - Static method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>
<div class="block">Gets the list of unsupported options.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.Attribute.html#getValue()" class="member-name-link">getValue()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/Matcher.Attribute.html" title="class in org.apache.rat.documentation.velocity">Matcher.Attribute</a></dt>
<dd>
<div class="block">Gets the value of the enclosed matcher.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.Enclosed.html#getValue()" class="member-name-link">getValue()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/Matcher.Enclosed.html" title="class in org.apache.rat.documentation.velocity">Matcher.Enclosed</a></dt>
<dd>
<div class="block">Gets the value of the enclosed matcher.</div>
</dd>
</dl>
<h2 class="title" id="I:H">H</h2>
<dl class="index">
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#hasArg()" class="member-name-link">hasArg()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Determine if the enclosed option expects an argument.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#hasArgs()" class="member-name-link">hasArgs()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Returns <code>true</code> if the option has multiple arguments.</div>
</dd>
</dl>
<h2 class="title" id="I:I">I</h2>
<dl class="index">
<dt><a href="org/apache/rat/documentation/velocity/License.html#id()" class="member-name-link">id()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/License.html" title="class in org.apache.rat.documentation.velocity">License</a></dt>
<dd>
<div class="block">Gets the id for this license if it is not a system generated one.</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.html#init()" class="member-name-link">init()</a> - Method in class org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.html" title="class in org.apache.rat.tools.xsd">XsdWriter</a></dt>
<dd>
<div class="block">Initializes the writer.</div>
</dd>
<dt><a href="org/apache/rat/tools/AntGenerator.GenerateType.html#innerClass" class="member-name-link">innerClass</a> - Variable in class org.apache.rat.tools.<a href="org/apache/rat/tools/AntGenerator.GenerateType.html" title="class in org.apache.rat.tools">AntGenerator.GenerateType</a></dt>
<dd>
<div class="block">the inner class name text</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html#isAttribute()" class="member-name-link">isAttribute()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>
<div class="block">Returns <code>true</code> if the option should be an attribute of the &lt;rat:report&gt; element.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#isDeprecated()" class="member-name-link">isDeprecated()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Determines if the option is deprecated.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AntOption.html#isElement()" class="member-name-link">isElement()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></dt>
<dd>
<div class="block">Returns <code>true</code> if the option should be a child element of the &lt;rat:report&gt; element.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#isRequired()" class="member-name-link">isRequired()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">Determines if the option is required.</div>
</dd>
</dl>
<h2 class="title" id="I:K">K</h2>
<dl class="index">
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#keyValue()" class="member-name-link">keyValue()</a> - Method in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">The key value for the option.</div>
</dd>
</dl>
<h2 class="title" id="I:L">L</h2>
<dl class="index">
<dt><a href="org/apache/rat/documentation/velocity/MatcherTree.Node.html#level()" class="member-name-link">level()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/MatcherTree.Node.html" title="class in org.apache.rat.documentation.velocity">MatcherTree.Node</a></dt>
<dd>
<div class="block">Gets the level in the tree of this node.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/License.html" class="type-name-link" title="class in org.apache.rat.documentation.velocity">License</a> - Class in <a href="org/apache/rat/documentation/velocity/package-summary.html">org.apache.rat.documentation.velocity</a></dt>
<dd>
<div class="block">The License representation for documentation.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#licenseProperties()" class="member-name-link">licenseProperties()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Gets a list of license property descriptions.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#licenses()" class="member-name-link">licenses()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Gets the list of defined licenses.</div>
</dd>
</dl>
<h2 class="title" id="I:M">M</h2>
<dl class="index">
<dt><a href="org/apache/rat/documentation/Exporter.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - Static method in class org.apache.rat.documentation.<a href="org/apache/rat/documentation/Exporter.html" title="class in org.apache.rat.documentation">Exporter</a></dt>
<dd>
<div class="block">Executes the generation of documentation from a configuration definition.</div>
</dd>
<dt><a href="org/apache/rat/tools/AntDocumentation.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - Static method in class org.apache.rat.tools.<a href="org/apache/rat/tools/AntDocumentation.html" title="class in org.apache.rat.tools">AntDocumentation</a></dt>
<dd>
<div class="block">Creates apt documentation files for Ant.</div>
</dd>
<dt><a href="org/apache/rat/tools/AntGenerator.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - Static method in class org.apache.rat.tools.<a href="org/apache/rat/tools/AntGenerator.html" title="class in org.apache.rat.tools">AntGenerator</a></dt>
<dd>
<div class="block">Creates a base class for an Ant task.</div>
</dd>
<dt><a href="org/apache/rat/tools/ArgumentTypes.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - Static method in class org.apache.rat.tools.<a href="org/apache/rat/tools/ArgumentTypes.html" title="class in org.apache.rat.tools">ArgumentTypes</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/tools/Documentation.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - Static method in class org.apache.rat.tools.<a href="org/apache/rat/tools/Documentation.html" title="class in org.apache.rat.tools">Documentation</a></dt>
<dd>
<div class="block">Creates the documentation.</div>
</dd>
<dt><a href="org/apache/rat/tools/MavenGenerator.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - Static method in class org.apache.rat.tools.<a href="org/apache/rat/tools/MavenGenerator.html" title="class in org.apache.rat.tools">MavenGenerator</a></dt>
<dd>
<div class="block">Creates the Maven MojoClass
Requires 3 arguments:
the package name for the class
the simple class name
the directory in which to write the class file.
</div>
</dd>
<dt><a href="org/apache/rat/tools/Naming.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - Static method in class org.apache.rat.tools.<a href="org/apache/rat/tools/Naming.html" title="class in org.apache.rat.tools">Naming</a></dt>
<dd>
<div class="block">Creates the CSV file.</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdGenerator.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - Static method in class org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdGenerator.html" title="class in org.apache.rat.tools.xsd">XsdGenerator</a></dt>
<dd>
<div class="block">Command line that accepts standard RAT CLI command line options and generates an XSD from the
configuration.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#markdownEscape(java.lang.String)" class="member-name-link">markdownEscape(String)</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Escapes a string for markdown.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.html" class="type-name-link" title="class in org.apache.rat.documentation.velocity">Matcher</a> - Class in <a href="org/apache/rat/documentation/velocity/package-summary.html">org.apache.rat.documentation.velocity</a></dt>
<dd>
<div class="block">The Matcher representation for documentation.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.Attribute.html" class="type-name-link" title="class in org.apache.rat.documentation.velocity">Matcher.Attribute</a> - Class in <a href="org/apache/rat/documentation/velocity/package-summary.html">org.apache.rat.documentation.velocity</a></dt>
<dd>
<div class="block">The definition of an attribute.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/Matcher.Enclosed.html" class="type-name-link" title="class in org.apache.rat.documentation.velocity">Matcher.Enclosed</a> - Class in <a href="org/apache/rat/documentation/velocity/package-summary.html">org.apache.rat.documentation.velocity</a></dt>
<dd>
<div class="block">The description of an enclosed matcher.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#matchers()" class="member-name-link">matchers()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Gets the set of Matchers.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/MatcherTree.html" class="type-name-link" title="class in org.apache.rat.documentation.velocity">MatcherTree</a> - Class in <a href="org/apache/rat/documentation/velocity/package-summary.html">org.apache.rat.documentation.velocity</a></dt>
<dd>
<div class="block">The representation of the Matcher tree found in a License.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/MatcherTree.html#%3Cinit%3E(org.apache.rat.analysis.IHeaderMatcher)" class="member-name-link">MatcherTree(IHeaderMatcher)</a> - Constructor for class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/MatcherTree.html" title="class in org.apache.rat.documentation.velocity">MatcherTree</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/MatcherTree.Node.html" class="type-name-link" title="class in org.apache.rat.documentation.velocity">MatcherTree.Node</a> - Class in <a href="org/apache/rat/documentation/velocity/package-summary.html">org.apache.rat.documentation.velocity</a></dt>
<dd>
<div class="block">The representation of a node in a License Matcher tree.</div>
</dd>
<dt><a href="org/apache/rat/tools/MavenGenerator.html" class="type-name-link" title="class in org.apache.rat.tools">MavenGenerator</a> - Class in <a href="org/apache/rat/tools/package-summary.html">org.apache.rat.tools</a></dt>
<dd>
<div class="block">A simple tool to convert CLI options to a Maven Mojo base class.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/MavenOption.html" class="type-name-link" title="class in org.apache.rat.documentation.options">MavenOption</a> - Class in <a href="org/apache/rat/documentation/options/package-summary.html">org.apache.rat.documentation.options</a></dt>
<dd>
<div class="block">A representation of a CLI option as a Maven option</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/MavenOption.html#%3Cinit%3E(org.apache.commons.cli.Option)" class="member-name-link">MavenOption(Option)</a> - Constructor for class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/MavenOption.html" title="class in org.apache.rat.documentation.options">MavenOption</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#mvnOptions()" class="member-name-link">mvnOptions()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Gets a map client option name to Maven Option.</div>
</dd>
</dl>
<h2 class="title" id="I:N">N</h2>
<dl class="index">
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#name" class="member-name-link">name</a> - Variable in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">The name for the option</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/License.html#name()" class="member-name-link">name()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/License.html" title="class in org.apache.rat.documentation.velocity">License</a></dt>
<dd>
<div class="block">Gets the name of this license.</div>
</dd>
<dt><a href="org/apache/rat/tools/Naming.html" class="type-name-link" title="class in org.apache.rat.tools">Naming</a> - Class in <a href="org/apache/rat/tools/package-summary.html">org.apache.rat.tools</a></dt>
<dd>
<div class="block">A simple tool to convert CLI options to Maven and Ant format and produce a CSV file.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/License.html#note()" class="member-name-link">note()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/License.html" title="class in org.apache.rat.documentation.velocity">License</a></dt>
<dd>
<div class="block">Gets the space normalized note for the license.</div>
</dd>
</dl>
<h2 class="title" id="I:O">O</h2>
<dl class="index">
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.html#open(org.apache.rat.tools.xsd.XsdWriter.Type,java.lang.String...)" class="member-name-link">open(XsdWriter.Type, String...)</a> - Method in class org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.html" title="class in org.apache.rat.tools.xsd">XsdWriter</a></dt>
<dd>
<div class="block">Opens (Starts) an element of the specified type along with its attributes.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#option" class="member-name-link">option</a> - Variable in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">The actual UI-specific name for the option</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#options()" class="member-name-link">options()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Gets the list of command line options.</div>
</dd>
<dt><a href="org/apache/rat/documentation/package-summary.html">org.apache.rat.documentation</a> - package org.apache.rat.documentation</dt>
<dd>
<div class="block">Contains tools for generating documentation.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/package-summary.html">org.apache.rat.documentation.options</a> - package org.apache.rat.documentation.options</dt>
<dd>
<div class="block">Contains ancillary enhanced options for the various RAT interfaces.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/package-summary.html">org.apache.rat.documentation.velocity</a> - package org.apache.rat.documentation.velocity</dt>
<dd>
<div class="block">Contains velocity based tools and accessories.</div>
</dd>
<dt><a href="org/apache/rat/tools/package-summary.html">org.apache.rat.tools</a> - package org.apache.rat.tools</dt>
<dd>
<div class="block">Contains ancillary tools for the RAT program including code generators and name harmonization code.</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/package-summary.html">org.apache.rat.tools.xsd</a> - package org.apache.rat.tools.xsd</dt>
<dd>
<div class="block">Contains XSD file generation tools.</div>
</dd>
</dl>
<h2 class="title" id="I:P">P</h2>
<dl class="index">
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#pad(int)" class="member-name-link">pad(int)</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Creates a string of spaces of the specified length.</div>
</dd>
<dt><a href="org/apache/rat/documentation/options/AbstractOption.html#PATTERN" class="member-name-link">PATTERN</a> - Static variable in class org.apache.rat.documentation.options.<a href="org/apache/rat/documentation/options/AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></dt>
<dd>
<div class="block">The pattern to match CLI options in text</div>
</dd>
</dl>
<h2 class="title" id="I:R">R</h2>
<dl class="index">
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html" class="type-name-link" title="class in org.apache.rat.documentation.velocity">RatTool</a> - Class in <a href="org/apache/rat/documentation/velocity/package-summary.html">org.apache.rat.documentation.velocity</a></dt>
<dd>
<div class="block">The Velocity RAT plugin that provides access to the RAT data.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#%3Cinit%3E()" class="member-name-link">RatTool()</a> - Constructor for class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
</dl>
<h2 class="title" id="I:S">S</h2>
<dl class="index">
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.Type.html#SEQUENCE" class="member-name-link">SEQUENCE</a> - Enum constant in enum org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.Type.html" title="enum in org.apache.rat.tools.xsd">XsdWriter.Type</a></dt>
<dd>
<div class="block">A sequence</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.Type.html#SIMPLE" class="member-name-link">SIMPLE</a> - Enum constant in enum org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.Type.html" title="enum in org.apache.rat.tools.xsd">XsdWriter.Type</a></dt>
<dd>
<div class="block">A simple type</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#standardCollections()" class="member-name-link">standardCollections()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Gets the list of standard collections.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#stringUtils()" class="member-name-link">stringUtils()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Gets the <code>StringUtils</code> object in order to work with it in Velocity templates.</div>
</dd>
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#styleSheets()" class="member-name-link">styleSheets()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Gets the list of stylesheets.</div>
</dd>
</dl>
<h2 class="title" id="I:T">T</h2>
<dl class="index">
<dt><a href="org/apache/rat/documentation/velocity/RatTool.html#tab()" class="member-name-link">tab()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/RatTool.html" title="class in org.apache.rat.documentation.velocity">RatTool</a></dt>
<dd>
<div class="block">Gets a tab character.</div>
</dd>
<dt><a href="org/apache/rat/documentation/Exporter.html#toString()" class="member-name-link">toString()</a> - Method in class org.apache.rat.documentation.<a href="org/apache/rat/documentation/Exporter.html" title="class in org.apache.rat.documentation">Exporter</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/documentation/velocity/MatcherTree.html#traverse()" class="member-name-link">traverse()</a> - Method in class org.apache.rat.documentation.velocity.<a href="org/apache/rat/documentation/velocity/MatcherTree.html" title="class in org.apache.rat.documentation.velocity">MatcherTree</a></dt>
<dd>
<div class="block">Executes an in-order-traversal of the tree.</div>
</dd>
</dl>
<h2 class="title" id="I:V">V</h2>
<dl class="index">
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.Type.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.Type.html" title="enum in org.apache.rat.tools.xsd">XsdWriter.Type</a></dt>
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.Type.html#values()" class="member-name-link">values()</a> - Static method in enum org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.Type.html" title="enum in org.apache.rat.tools.xsd">XsdWriter.Type</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</dd>
</dl>
<h2 class="title" id="I:W">W</h2>
<dl class="index">
<dt><a href="org/apache/rat/tools/xsd/XsdGenerator.html#write(java.io.Writer)" class="member-name-link">write(Writer)</a> - Method in class org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdGenerator.html" title="class in org.apache.rat.tools.xsd">XsdGenerator</a></dt>
<dd>
<div class="block">Writes the XSD to the output.</div>
</dd>
<dt><a href="org/apache/rat/tools/AntDocumentation.html#writeAttributes(java.util.List)" class="member-name-link">writeAttributes(List&lt;AntOption&gt;)</a> - Method in class org.apache.rat.tools.<a href="org/apache/rat/tools/AntDocumentation.html" title="class in org.apache.rat.tools">AntDocumentation</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/tools/AntDocumentation.html#writeElements(java.util.List)" class="member-name-link">writeElements(List&lt;AntOption&gt;)</a> - Method in class org.apache.rat.tools.<a href="org/apache/rat/tools/AntDocumentation.html" title="class in org.apache.rat.tools">AntDocumentation</a></dt>
<dd>&nbsp;</dd>
</dl>
<h2 class="title" id="I:X">X</h2>
<dl class="index">
<dt><a href="org/apache/rat/tools/xsd/XsdGenerator.html" class="type-name-link" title="class in org.apache.rat.tools.xsd">XsdGenerator</a> - Class in <a href="org/apache/rat/tools/xsd/package-summary.html">org.apache.rat.tools.xsd</a></dt>
<dd>
<div class="block">Generates the XSD for a configuration.</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdGenerator.html#%3Cinit%3E()" class="member-name-link">XsdGenerator()</a> - Constructor for class org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdGenerator.html" title="class in org.apache.rat.tools.xsd">XsdGenerator</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.html" class="type-name-link" title="class in org.apache.rat.tools.xsd">XsdWriter</a> - Class in <a href="org/apache/rat/tools/xsd/package-summary.html">org.apache.rat.tools.xsd</a></dt>
<dd>
<div class="block">A writer that writes XSD nodes.</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.html#%3Cinit%3E(java.io.Writer)" class="member-name-link">XsdWriter(Writer)</a> - Constructor for class org.apache.rat.tools.xsd.<a href="org/apache/rat/tools/xsd/XsdWriter.html" title="class in org.apache.rat.tools.xsd">XsdWriter</a></dt>
<dd>
<div class="block">Creates an XSD writer that wraps a standard Writer.</div>
</dd>
<dt><a href="org/apache/rat/tools/xsd/XsdWriter.Type.html" class="type-name-link" title="enum in org.apache.rat.tools.xsd">XsdWriter.Type</a> - Enum in <a href="org/apache/rat/tools/xsd/package-summary.html">org.apache.rat.tools.xsd</a></dt>
<dd>
<div class="block">Types of elements in the XSD</div>
</dd>
</dl>
<a href="#I:A">A</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:H">H</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:K">K</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:N">N</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:V">V</a>&nbsp;<a href="#I:W">W</a>&nbsp;<a href="#I:X">X</a>&nbsp;<br><a href="allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All&nbsp;Packages</a></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>