Google Git
Sign in
apache / creadur-site / HEAD / . / rat017 / apidocs / org / apache / rat / anttasks / Report.html
blob: 4341890b795bc1acb928f75c4013cd80259380b5 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (21) -->
<title>Report (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.anttasks, class: Report">
<meta name="generator" content="javadoc/ClassWriterImpl">
<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="class-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><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/Report.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#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li><a href="#nested-class-summary">Nested</a></li>
<li><a href="#field-summary">Field</a></li>
<li><a href="#constructor-summary">Constr</a></li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li><a href="#constructor-detail">Constr</a></li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</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">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.rat.anttasks</a></div>
<h1 title="Class Report" class="title">Class Report</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.tools.ant.ProjectComponent
<div class="inheritance">org.apache.tools.ant.Task
<div class="inheritance"><a href="BaseAntTask.html" title="class in org.apache.rat.anttasks">org.apache.rat.anttasks.BaseAntTask</a>
<div class="inheritance">org.apache.rat.anttasks.Report</div>
</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Report</span>
<span class="extends-implements">extends <a href="BaseAntTask.html" title="class in org.apache.rat.anttasks">BaseAntTask</a></span></div>
<div class="block">A basic Ant task that generates a report on all files specified by the nested
resource collection(s).
<p>
IHeaderMatcher(s) can be specified as nested elements as well.
</p>
<p>
The attribute <code>format</code> defines the output format and can take the
values
<ul>
<li>xml - RAT's native XML output.</li>
<li>styled - transforms the XML output using the given stylesheet. The
stylesheet attribute must be set as well if this attribute is used.</li>
<li>plain - plain text using RAT's built-in stylesheet. This is the
default.</li>
</ul></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="Report.AddLicenseHeaders.html" class="type-name-link" title="class in org.apache.rat.anttasks">Report.AddLicenseHeaders</a></code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use &lt;editCopyright&gt; amd &lt;editOverwrite&gt; instead.</div>
</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="Report.ApprovalFilter.html" class="type-name-link" title="class in org.apache.rat.anttasks">Report.ApprovalFilter</a></code></div>
<div class="col-last odd-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use listLicenses or listFamilies attributes.</div>
</div>
</div>
</div>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.rat.anttasks.BaseAntTask">Nested classes/interfaces inherited from class&nbsp;org.apache.rat.anttasks.<a href="BaseAntTask.html" title="class in org.apache.rat.anttasks">BaseAntTask</a></h2>
<code><a href="BaseAntTask.Cntr.html" title="class in org.apache.rat.anttasks">BaseAntTask.Cntr</a>, <a href="BaseAntTask.Config.html" title="class in org.apache.rat.anttasks">BaseAntTask.Config</a>, <a href="BaseAntTask.CounterMax.html" title="class in org.apache.rat.anttasks">BaseAntTask.CounterMax</a>, <a href="BaseAntTask.CounterMin.html" title="class in org.apache.rat.anttasks">BaseAntTask.CounterMin</a>, <a href="BaseAntTask.Exclude.html" title="class in org.apache.rat.anttasks">BaseAntTask.Exclude</a>, <a href="BaseAntTask.Expr.html" title="class in org.apache.rat.anttasks">BaseAntTask.Expr</a>, <a href="BaseAntTask.Filename.html" title="class in org.apache.rat.anttasks">BaseAntTask.Filename</a>, <a href="BaseAntTask.Include.html" title="class in org.apache.rat.anttasks">BaseAntTask.Include</a>, <a href="BaseAntTask.InputExclude.html" title="class in org.apache.rat.anttasks">BaseAntTask.InputExclude</a>, <a href="BaseAntTask.InputExcludeParsedScm.html" title="class in org.apache.rat.anttasks">BaseAntTask.InputExcludeParsedScm</a>, <a href="BaseAntTask.InputInclude.html" title="class in org.apache.rat.anttasks">BaseAntTask.InputInclude</a>, <a href="BaseAntTask.LicenseFamiliesApproved.html" title="class in org.apache.rat.anttasks">BaseAntTask.LicenseFamiliesApproved</a>, <a href="BaseAntTask.LicenseFamiliesDenied.html" title="class in org.apache.rat.anttasks">BaseAntTask.LicenseFamiliesDenied</a>, <a href="BaseAntTask.Licenses.html" title="class in org.apache.rat.anttasks">BaseAntTask.Licenses</a>, <a href="BaseAntTask.LicensesApproved.html" title="class in org.apache.rat.anttasks">BaseAntTask.LicensesApproved</a>, <a href="BaseAntTask.LicensesDenied.html" title="class in org.apache.rat.anttasks">BaseAntTask.LicensesDenied</a>, <a href="BaseAntTask.Lst.html" title="class in org.apache.rat.anttasks">BaseAntTask.Lst</a>, <a href="BaseAntTask.Std.html" title="class in org.apache.rat.anttasks">BaseAntTask.Std</a>, <a href="BaseAntTask.TxtValue.html" title="class in org.apache.rat.anttasks">BaseAntTask.TxtValue</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.rat.anttasks.BaseAntTask">Fields inherited from class&nbsp;org.apache.rat.anttasks.<a href="BaseAntTask.html" title="class in org.apache.rat.anttasks">BaseAntTask</a></h3>
<code><a href="BaseAntTask.html#args">args</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.tools.ant.Task">Fields inherited from class&nbsp;org.apache.tools.ant.Task</h3>
<code>target, taskName, taskType, wrapper</code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.tools.ant.ProjectComponent">Fields inherited from class&nbsp;org.apache.tools.ant.ProjectComponent</h3>
<code>description, location, project</code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Report</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Constructor.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.apache.tools.ant.types.ResourceCollection)" class="member-name-link">add</a><wbr>(org.apache.tools.ant.types.ResourceCollection&nbsp;rc)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Adds resources that will be checked.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#addAddApprovedLicense(java.lang.String)" class="member-name-link">addAddApprovedLicense</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;familyCategory)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use licensesFamiliesApproved child element</div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#addFamily(org.apache.rat.anttasks.Family)" class="member-name-link">addFamily</a><wbr>(<a href="Family.html" title="class in org.apache.rat.anttasks">Family</a>&nbsp;family)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Create a custom configuration file and use the config option.</div>
</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#addLicense(org.apache.rat.anttasks.License)" class="member-name-link">addLicense</a><wbr>(<a href="License.html" title="class in org.apache.rat.anttasks">License</a>&nbsp;license)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Create a custom configuration file and use the config option.</div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#addRemoveApprovedLicense(java.lang.String)" class="member-name-link">addRemoveApprovedLicense</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;familyCategory)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use licensesFamiliesDenied child element</div>
</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#addRemoveApprovedLicense(java.lang.String%5B%5D)" class="member-name-link">addRemoveApprovedLicense</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;familyCategory)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use licenseFamilyDenied element</div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#addStylesheet(org.apache.tools.ant.types.Resource)" class="member-name-link">addStylesheet</a><wbr>(org.apache.tools.ant.types.Resource&nbsp;styleSheet)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use <a href="BaseAntTask.html#setStylesheet(java.lang.String)"><code>BaseAntTask.setStylesheet(String)</code></a></div>
</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#addStyleSheet(org.apache.tools.ant.types.Resource)" class="member-name-link">addStyleSheet</a><wbr>(org.apache.tools.ant.types.Resource&nbsp;styleSheet)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use <a href="BaseAntTask.html#setOutputStyle(java.lang.String)"><code>BaseAntTask.setOutputStyle(String)</code></a></div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Generates the report.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../utils/Log.Level.html" title="enum in org.apache.rat.utils">Log.Level</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#fromProjectLevel(int)" class="member-name-link">fromProjectLevel</a><wbr>(int&nbsp;level)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Converts to RAT log level from Ant Project log level.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConfiguration()" class="member-name-link">getConfiguration</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Creates the ReportConfiguration from the Ant options.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValues(org.apache.rat.commandline.Arg)" class="member-name-link">getValues</a><wbr>(<a href="../commandline/Arg.html" title="enum in org.apache.rat.commandline">Arg</a>&nbsp;arg)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Reads values for the Arg.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#log(java.lang.String,int)" class="member-name-link">log</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;msg,
int&nbsp;msgLevel)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#log(java.lang.String,java.lang.Throwable,int)" class="member-name-link">log</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;msg,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a>&nbsp;t,
int&nbsp;msgLevel)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeKey(org.apache.rat.commandline.Arg)" class="member-name-link">removeKey</a><wbr>(<a href="../commandline/Arg.html" title="enum in org.apache.rat.commandline">Arg</a>&nbsp;arg)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Removes the values for the arg.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setAddApprovedLicense(java.lang.String)" class="member-name-link">setAddApprovedLicense</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;familyCategory)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use licensesApproved child element.</div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setAddDefaultDefinitions(java.io.File)" class="member-name-link">setAddDefaultDefinitions</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;fileName)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use Config child element</div>
</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setAddLicenseHeaders(org.apache.rat.anttasks.Report.AddLicenseHeaders)" class="member-name-link">setAddLicenseHeaders</a><wbr>(<a href="Report.AddLicenseHeaders.html" title="class in org.apache.rat.anttasks">Report.AddLicenseHeaders</a>&nbsp;setting)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use editLicense and editOverwrite attributes</div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setCopyrightMessage(java.lang.String)" class="member-name-link">setCopyrightMessage</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;copyrightMessage)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use copyright attribute</div>
</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setFormat(java.lang.String)" class="member-name-link">setFormat</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;style)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use <a href="BaseAntTask.html#setStylesheet(java.lang.String)"><code>BaseAntTask.setStylesheet(String)</code></a></div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setInputFileFilter(org.apache.commons.io.filefilter.IOFileFilter)" class="member-name-link">setInputFileFilter</a><wbr>(org.apache.commons.io.filefilter.IOFileFilter&nbsp;inputFileFilter)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setLicenses(java.io.File)" class="member-name-link">setLicenses</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;fileName)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">create a configuration file and use the &lt;config&gt; child element.</div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setRemoveApprovedLicense(java.lang.String)" class="member-name-link">setRemoveApprovedLicense</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;familyCategory)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use licensesFamiliesDenied child element</div>
</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setRemoveApprovedLicense(java.lang.String%5B%5D)" class="member-name-link">setRemoveApprovedLicense</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;familyCategory)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use licenseFamiliesDenied element</div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setReportFile(java.io.File)" class="member-name-link">setReportFile</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;reportFile)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use outputFile element</div>
</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setStyleReport(boolean)" class="member-name-link">setStyleReport</a><wbr>(boolean&nbsp;styleReport)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use <a href="BaseAntTask.html#setOutputStyle(java.lang.String)"><code>BaseAntTask.setOutputStyle(String)</code></a> and pass "xml" or "plain-rat".</div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setUseDefaultLicenses(boolean)" class="member-name-link">setUseDefaultLicenses</a><wbr>(boolean&nbsp;useDefaultLicenses)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use noDefaultLicenses attribute</div>
</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate(org.apache.rat.ReportConfiguration)" class="member-name-link">validate</a><wbr>(<a href="../ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a>&nbsp;cfg)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">validates the task's configuration.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.rat.anttasks.BaseAntTask">Methods inherited from class&nbsp;org.apache.rat.anttasks.<a href="BaseAntTask.html" title="class in org.apache.rat.anttasks">BaseAntTask</a></h3>
<code><a href="BaseAntTask.html#addArg(java.lang.String,java.lang.String)">addArg</a>, <a href="BaseAntTask.html#addArg(java.lang.String,java.lang.String%5B%5D)">addArg</a>, <a href="BaseAntTask.html#args()">args</a>, <a href="BaseAntTask.html#createConfig()">createConfig</a>, <a href="BaseAntTask.html#createCounterMax()">createCounterMax</a>, <a href="BaseAntTask.html#createCounterMin()">createCounterMin</a>, <a href="BaseAntTask.html#createExclude()">createExclude</a>, <a href="BaseAntTask.html#createInclude()">createInclude</a>, <a href="BaseAntTask.html#createInputExclude()">createInputExclude</a>, <a href="BaseAntTask.html#createInputExcludeParsedScm()">createInputExcludeParsedScm</a>, <a href="BaseAntTask.html#createInputInclude()">createInputInclude</a>, <a href="BaseAntTask.html#createLicenseFamiliesApproved()">createLicenseFamiliesApproved</a>, <a href="BaseAntTask.html#createLicenseFamiliesDenied()">createLicenseFamiliesDenied</a>, <a href="BaseAntTask.html#createLicenses()">createLicenses</a>, <a href="BaseAntTask.html#createLicensesApproved()">createLicensesApproved</a>, <a href="BaseAntTask.html#createLicensesDenied()">createLicensesDenied</a>, <a href="BaseAntTask.html#createName(java.lang.String)">createName</a>, <a href="BaseAntTask.html#getArg(java.lang.String)">getArg</a>, <a href="BaseAntTask.html#removeArg(java.lang.String)">removeArg</a>, <a href="BaseAntTask.html#setAddLicense(boolean)">setAddLicense</a>, <a href="BaseAntTask.html#setArg(java.lang.String,java.lang.String)">setArg</a>, <a href="BaseAntTask.html#setConfigurationNoDefaults(boolean)">setConfigurationNoDefaults</a>, <a href="BaseAntTask.html#setCopyright(java.lang.String)">setCopyright</a>, <a href="BaseAntTask.html#setDryRun(boolean)">setDryRun</a>, <a href="BaseAntTask.html#setEditCopyright(java.lang.String)">setEditCopyright</a>, <a href="BaseAntTask.html#setEditLicense(boolean)">setEditLicense</a>, <a href="BaseAntTask.html#setEditOverwrite(boolean)">setEditOverwrite</a>, <a href="BaseAntTask.html#setExcludeFile(java.lang.String)">setExcludeFile</a>, <a href="BaseAntTask.html#setForce(boolean)">setForce</a>, <a href="BaseAntTask.html#setHelpLicenses(boolean)">setHelpLicenses</a>, <a href="BaseAntTask.html#setIncludesFile(java.lang.String)">setIncludesFile</a>, <a href="BaseAntTask.html#setInputExcludeSize(java.lang.String)">setInputExcludeSize</a>, <a href="BaseAntTask.html#setListFamilies(java.lang.String)">setListFamilies</a>, <a href="BaseAntTask.html#setListLicenses(java.lang.String)">setListLicenses</a>, <a href="BaseAntTask.html#setNoDefaultLicenses(boolean)">setNoDefaultLicenses</a>, <a href="BaseAntTask.html#setOut(java.lang.String)">setOut</a>, <a href="BaseAntTask.html#setOutputArchive(java.lang.String)">setOutputArchive</a>, <a href="BaseAntTask.html#setOutputFamilies(java.lang.String)">setOutputFamilies</a>, <a href="BaseAntTask.html#setOutputFile(java.lang.String)">setOutputFile</a>, <a href="BaseAntTask.html#setOutputLicenses(java.lang.String)">setOutputLicenses</a>, <a href="BaseAntTask.html#setOutputStandard(java.lang.String)">setOutputStandard</a>, <a href="BaseAntTask.html#setOutputStyle(java.lang.String)">setOutputStyle</a>, <a href="BaseAntTask.html#setScanHiddenDirectories(boolean)">setScanHiddenDirectories</a>, <a href="BaseAntTask.html#setStylesheet(java.lang.String)">setStylesheet</a>, <a href="BaseAntTask.html#setXml(boolean)">setXml</a>, <a href="BaseAntTask.html#unsupportedArgs()">unsupportedArgs</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.tools.ant.Task">Methods inherited from class&nbsp;org.apache.tools.ant.Task</h3>
<code>bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType</code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.tools.ant.ProjectComponent">Methods inherited from class&nbsp;org.apache.tools.ant.ProjectComponent</h3>
<code>clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject</code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>Report</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Report</span>()</div>
<div class="block">Constructor.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="add(org.apache.tools.ant.types.ResourceCollection)">
<h3>add</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">add</span><wbr><span class="parameters">(org.apache.tools.ant.types.ResourceCollection&nbsp;rc)</span></div>
<div class="block">Adds resources that will be checked.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>rc</code> - resource to check.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setInputFileFilter(org.apache.commons.io.filefilter.IOFileFilter)">
<h3>setInputFileFilter</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setInputFileFilter</span><wbr><span class="parameters">(org.apache.commons.io.filefilter.IOFileFilter&nbsp;inputFileFilter)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Adds an input file filter.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>inputFileFilter</code> - The input file filter to add.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setReportFile(java.io.File)">
<h3>setReportFile</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setReportFile</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;reportFile)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use outputFile element</div>
</div>
<div class="block">Sets the report file.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>reportFile</code> - the report file.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addLicense(org.apache.rat.anttasks.License)">
<h3>addLicense</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addLicense</span><wbr><span class="parameters">(<a href="License.html" title="class in org.apache.rat.anttasks">License</a>&nbsp;license)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Create a custom configuration file and use the config option.</div>
</div>
<div class="block">Adds an inline License definition to the system.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>license</code> - the license to add.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addFamily(org.apache.rat.anttasks.Family)">
<h3>addFamily</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addFamily</span><wbr><span class="parameters">(<a href="Family.html" title="class in org.apache.rat.anttasks">Family</a>&nbsp;family)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Create a custom configuration file and use the config option.</div>
</div>
<div class="block">Add an inline license family definition to the system.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>family</code> - the license family to add.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addStylesheet(org.apache.tools.ant.types.Resource)">
<h3>addStylesheet</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addStylesheet</span><wbr><span class="parameters">(org.apache.tools.ant.types.Resource&nbsp;styleSheet)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use <a href="BaseAntTask.html#setStylesheet(java.lang.String)"><code>BaseAntTask.setStylesheet(String)</code></a></div>
</div>
<div class="block">Adds a style sheet to the system.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>styleSheet</code> - The style sheet to use for formatting.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addStyleSheet(org.apache.tools.ant.types.Resource)">
<h3>addStyleSheet</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addStyleSheet</span><wbr><span class="parameters">(org.apache.tools.ant.types.Resource&nbsp;styleSheet)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use <a href="BaseAntTask.html#setOutputStyle(java.lang.String)"><code>BaseAntTask.setOutputStyle(String)</code></a></div>
</div>
<div class="block">Adds a given style sheet to the report.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>styleSheet</code> - style sheet to use in this report.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setStyleReport(boolean)">
<h3>setStyleReport</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setStyleReport</span><wbr><span class="parameters">(boolean&nbsp;styleReport)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use <a href="BaseAntTask.html#setOutputStyle(java.lang.String)"><code>BaseAntTask.setOutputStyle(String)</code></a> and pass "xml" or "plain-rat".</div>
</div>
<div class="block">Styles the report or deliver xml document.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>styleReport</code> - true to use the plain-rat style</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setFormat(java.lang.String)">
<h3>setFormat</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setFormat</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;style)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use <a href="BaseAntTask.html#setStylesheet(java.lang.String)"><code>BaseAntTask.setStylesheet(String)</code></a></div>
</div>
<div class="block">Determines if the output should be styled.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>style</code> - the name of the style sheet ot use, or "styled" for plain-rat style</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setLicenses(java.io.File)">
<h3>setLicenses</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setLicenses</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;fileName)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">create a configuration file and use the &lt;config&gt; child element.</div>
</div>
<div class="block">Adds as a file containing the definitions of licenses to the system.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>fileName</code> - the file to add.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setUseDefaultLicenses(boolean)">
<h3>setUseDefaultLicenses</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setUseDefaultLicenses</span><wbr><span class="parameters">(boolean&nbsp;useDefaultLicenses)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use noDefaultLicenses attribute</div>
</div>
<div class="block">Specifies whether to add the default list of license matchers.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>useDefaultLicenses</code> - if <code>true</code> use the default licenses.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setAddApprovedLicense(java.lang.String)">
<h3>setAddApprovedLicense</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setAddApprovedLicense</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;familyCategory)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use licensesApproved child element.</div>
</div>
<div class="block">Adds a family category to the list of approved licenses.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>familyCategory</code> - the category to add.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addAddApprovedLicense(java.lang.String)">
<h3>addAddApprovedLicense</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addAddApprovedLicense</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;familyCategory)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use licensesFamiliesApproved child element</div>
</div>
<div class="block">Adds a family category to the list of approved licenses.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>familyCategory</code> - the category to add</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setRemoveApprovedLicense(java.lang.String)">
<h3>setRemoveApprovedLicense</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setRemoveApprovedLicense</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;familyCategory)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use licensesFamiliesDenied child element</div>
</div>
<div class="block">Removes a family category to the list of approved licenses.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>familyCategory</code> - the category to add.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addRemoveApprovedLicense(java.lang.String)">
<h3>addRemoveApprovedLicense</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addRemoveApprovedLicense</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;familyCategory)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use licensesFamiliesDenied child element</div>
</div>
<div class="block">Removes a family category to the list of approved licenses.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>familyCategory</code> - the category to add.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setRemoveApprovedLicense(java.lang.String[])">
<h3>setRemoveApprovedLicense</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setRemoveApprovedLicense</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;familyCategory)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use licenseFamiliesDenied element</div>
</div>
<div class="block">Removes a family category to the list of approved licenses.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>familyCategory</code> - the category to remove</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addRemoveApprovedLicense(java.lang.String[])">
<h3>addRemoveApprovedLicense</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addRemoveApprovedLicense</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;familyCategory)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use licenseFamilyDenied element</div>
</div>
<div class="block">Removes a family category to the list of approved licenses.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>familyCategory</code> - the category to remove.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setCopyrightMessage(java.lang.String)">
<h3>setCopyrightMessage</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setCopyrightMessage</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;copyrightMessage)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use copyright attribute</div>
</div>
<div class="block">Sets the copyright message</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>copyrightMessage</code> - the copyright message</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setAddLicenseHeaders(org.apache.rat.anttasks.Report.AddLicenseHeaders)">
<h3>setAddLicenseHeaders</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setAddLicenseHeaders</span><wbr><span class="parameters">(<a href="Report.AddLicenseHeaders.html" title="class in org.apache.rat.anttasks">Report.AddLicenseHeaders</a>&nbsp;setting)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use editLicense and editOverwrite attributes</div>
</div>
<div class="block">Determines if license headers should be added.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>setting</code> - the setting.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setAddDefaultDefinitions(java.io.File)">
<h3>setAddDefaultDefinitions</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setAddDefaultDefinitions</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;fileName)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use Config child element</div>
</div>
<div class="block">Adds definition information</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>fileName</code> - the file to add</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getValues(org.apache.rat.commandline.Arg)">
<h3>getValues</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getValues</span><wbr><span class="parameters">(<a href="../commandline/Arg.html" title="enum in org.apache.rat.commandline">Arg</a>&nbsp;arg)</span></div>
<div class="block">Reads values for the Arg.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>arg</code> - The Arg to get the values for.</dd>
<dt>Returns:</dt>
<dd>The list of values or an empty list.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="removeKey(org.apache.rat.commandline.Arg)">
<h3>removeKey</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">removeKey</span><wbr><span class="parameters">(<a href="../commandline/Arg.html" title="enum in org.apache.rat.commandline">Arg</a>&nbsp;arg)</span></div>
<div class="block">Removes the values for the arg.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>arg</code> - the arg to remove the values for.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getConfiguration()">
<h3>getConfiguration</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a></span>&nbsp;<span class="element-name">getConfiguration</span>()</div>
<div class="block">Creates the ReportConfiguration from the Ant options.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the ReportConfiguration.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execute()">
<h3>execute</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">execute</span>()</div>
<div class="block">Generates the report.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code>execute</code>&nbsp;in class&nbsp;<code>org.apache.tools.ant.Task</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="validate(org.apache.rat.ReportConfiguration)">
<h3>validate</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a></span>&nbsp;<span class="element-name">validate</span><wbr><span class="parameters">(<a href="../ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a>&nbsp;cfg)</span></div>
<div class="block">validates the task's configuration.</div>
</section>
</li>
<li>
<section class="detail" id="log(java.lang.String,int)">
<h3>log</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">log</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;msg,
int&nbsp;msgLevel)</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code>log</code>&nbsp;in class&nbsp;<code>org.apache.tools.ant.Task</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="log(java.lang.String,java.lang.Throwable,int)">
<h3>log</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">log</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;msg,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a>&nbsp;t,
int&nbsp;msgLevel)</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code>log</code>&nbsp;in class&nbsp;<code>org.apache.tools.ant.Task</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fromProjectLevel(int)">
<h3>fromProjectLevel</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../utils/Log.Level.html" title="enum in org.apache.rat.utils">Log.Level</a></span>&nbsp;<span class="element-name">fromProjectLevel</span><wbr><span class="parameters">(int&nbsp;level)</span></div>
<div class="block">Converts to RAT log level from Ant Project log level.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>level</code> - the Ant Project log level to convert.</dd>
<dt>Returns:</dt>
<dd>the equivalent RAT log level.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</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>