rat017/apidocs/org/apache/rat/ReportConfiguration.html - creadur-site - Git at Google

 <!DOCTYPE HTML>
 <html lang>
 <head>
 <!-- Generated by javadoc (21) -->
 <title>ReportConfiguration (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, class: ReportConfiguration">
 <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/ReportConfiguration.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>Field</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>Field&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</a></div>
 <h1 title="Class ReportConfiguration" class="title">Class ReportConfiguration</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.rat.ReportConfiguration</div>
 </div>
 <section class="class-description" id="class-description">
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ReportConfiguration</span>
 <span class="extends-implements">extends <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></span></div>
 <div class="block">A configuration object is used by the front end to invoke the
  <a href="Reporter.html" title="class in org.apache.rat"><code>Reporter</code></a>. The sole purpose of the frontends is to create the
  configuration and invoke the <a href="Reporter.html" title="class in org.apache.rat"><code>Reporter</code></a>.</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="ReportConfiguration.NoCloseOutputStream.html" class="type-name-link" title="class in org.apache.rat">ReportConfiguration.NoCloseOutputStream</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">A wrapper around an output stream that does not close the output stream.</div>
 </div>
 <div class="col-first odd-row-color"><code>static enum&nbsp;</code></div>
 <div class="col-second odd-row-color"><code><a href="ReportConfiguration.Processing.html" class="type-name-link" title="enum in org.apache.rat">ReportConfiguration.Processing</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">The styles of processing for various categories of documents.</div>
 </div>
 </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">ReportConfiguration</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-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></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="#addApprovedLicenseCategories(java.util.Collection)" class="member-name-link">addApprovedLicenseCategories</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</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;&nbsp;approvedLicenseCategories)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds a collection of license family categories to the set of approved license
  names.</div>
 </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="#addApprovedLicenseCategory(java.lang.String)" class="member-name-link">addApprovedLicenseCategory</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">
 <div class="block">Adds a license family category (id) to the list of approved licenses</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="#addApprovedLicenseCategory(org.apache.rat.license.ILicenseFamily)" class="member-name-link">addApprovedLicenseCategory</a><wbr>(<a href="license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>&nbsp;approvedILicenseFamily)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds an ILicenseFamily to the list of approved licenses.</div>
 </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="#addApprovedLicenseId(java.lang.String)" class="member-name-link">addApprovedLicenseId</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;licenseId)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds a license family category (id) to the list of approved licenses</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="#addApprovedLicenseId(org.apache.rat.license.ILicense)" class="member-name-link">addApprovedLicenseId</a><wbr>(<a href="license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a>&nbsp;approvedLicense)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds an ILicenseFamily to the list of approved licenses.</div>
 </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="#addApprovedLicenseIds(java.util.Collection)" class="member-name-link">addApprovedLicenseIds</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</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;&nbsp;approvedLicenseIds)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds a collection of license family categories to the set of approved license
  names.</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="#addExcludedCollection(org.apache.rat.config.exclusion.StandardCollection)" class="member-name-link">addExcludedCollection</a><wbr>(<a href="config/exclusion/StandardCollection.html" title="enum in org.apache.rat.config.exclusion">StandardCollection</a>&nbsp;collection)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Excludes a StandardCollection of patterns.</div>
 </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="#addExcludedFileProcessor(org.apache.rat.config.exclusion.StandardCollection)" class="member-name-link">addExcludedFileProcessor</a><wbr>(<a href="config/exclusion/StandardCollection.html" title="enum in org.apache.rat.config.exclusion">StandardCollection</a>&nbsp;collection)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Excludes the file processor defined in the StandardCollection.</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="#addExcludedFilter(java.io.FileFilter)" class="member-name-link">addExcludedFilter</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileFilter.html" title="class or interface in java.io" class="external-link">FileFilter</a>&nbsp;fileFilter)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Excludes files that match a FileFilter.</div>
 </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="#addExcludedMatcher(org.apache.rat.document.DocumentNameMatcher)" class="member-name-link">addExcludedMatcher</a><wbr>(<a href="document/DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>&nbsp;matcher)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Excludes files that match a DocumentNameMatcher.</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="#addExcludedPatterns(java.lang.Iterable)" class="member-name-link">addExcludedPatterns</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</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;&nbsp;patterns)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Excludes files that match the pattern.</div>
 </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="#addFamilies(java.util.Collection)" class="member-name-link">addFamilies</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>&gt;&nbsp;families)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds multiple families to the list of license families.</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="#addFamily(org.apache.rat.license.ILicenseFamily)" class="member-name-link">addFamily</a><wbr>(<a href="license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>&nbsp;family)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds a license family to the list of families.</div>
 </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="#addFamily(org.apache.rat.license.ILicenseFamily.Builder)" class="member-name-link">addFamily</a><wbr>(<a href="license/ILicenseFamily.Builder.html" title="class in org.apache.rat.license">ILicenseFamily.Builder</a>&nbsp;builder)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds a license family to the list of families.</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="#addIncludedCollection(org.apache.rat.config.exclusion.StandardCollection)" class="member-name-link">addIncludedCollection</a><wbr>(<a href="config/exclusion/StandardCollection.html" title="enum in org.apache.rat.config.exclusion">StandardCollection</a>&nbsp;collection)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds the patterns from the standard collection as included patterns.</div>
 </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="#addIncludedFilter(java.io.FileFilter)" class="member-name-link">addIncludedFilter</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileFilter.html" title="class or interface in java.io" class="external-link">FileFilter</a>&nbsp;fileFilter)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds the fileFilter to filter files that should be included, this overrides any
  exclusion of the same files.</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="#addIncludedPatterns(java.lang.Iterable)" class="member-name-link">addIncludedPatterns</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</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;&nbsp;patterns)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Add file patterns that are to be included.</div>
 </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="#addLicense(org.apache.rat.license.ILicense)" class="member-name-link">addLicense</a><wbr>(<a href="license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a>&nbsp;license)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds a license to the list of licenses.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addLicense(org.apache.rat.license.ILicense.Builder)" class="member-name-link">addLicense</a><wbr>(<a href="license/ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a>&nbsp;builder)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds a license to the list of licenses.</div>
 </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="#addLicenses(java.util.Collection)" class="member-name-link">addLicenses</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a>&gt;&nbsp;licenses)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds multiple licenses to the list of licenses.</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="#addSource(java.io.File)" class="member-name-link">addSource</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;file)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds a file as a source of files to scan.</div>
 </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="#addSource(org.apache.rat.report.IReportable)" class="member-name-link">addSource</a><wbr>(<a href="report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a>&nbsp;reportable)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds a Reportable as a source of files to scan.</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="#familyDuplicateOption(org.apache.rat.utils.ReportingSet.Options)" class="member-name-link">familyDuplicateOption</a><wbr>(<a href="utils/ReportingSet.Options.html" title="enum in org.apache.rat.utils">ReportingSet.Options</a>&nbsp;state)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the reporting option for duplicate license families.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReportConfiguration.Processing.html" title="enum in org.apache.rat">ReportConfiguration.Processing</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getArchiveProcessing()" class="member-name-link">getArchiveProcessing</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Retrieves the archive processing type.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="config/results/ClaimValidator.html" title="class in org.apache.rat.config.results">ClaimValidator</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClaimValidator()" class="member-name-link">getClaimValidator</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets the ClaimValidator for the configuration.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCopyrightMessage()" class="member-name-link">getCopyrightMessage</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the optional license copyright being added if RAT is adding headers.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="document/DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDocumentExcluder(org.apache.rat.document.DocumentName)" class="member-name-link">getDocumentExcluder</a><wbr>(<a href="document/DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>&nbsp;baseDir)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Get the DocumentNameMatcher that excludes files found in the directory tree..</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGeneratedMatcher()" class="member-name-link">getGeneratedMatcher</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets the matcher that matches generated text.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLicenseCategories(org.apache.rat.license.LicenseSetFactory.LicenseFilter)" class="member-name-link">getLicenseCategories</a><wbr>(<a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a>&nbsp;filter)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets the SortedSet of approved license categories.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</a><wbr>&lt;<a href="license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</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="#getLicenseFamilies(org.apache.rat.license.LicenseSetFactory.LicenseFilter)" class="member-name-link">getLicenseFamilies</a><wbr>(<a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a>&nbsp;filter)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets a sorted set of ILicenseFamily objects based on <code>filter</code>. if
  filter is set:

  <code>all</code> - All licenses families will be returned.
  <code>approved</code> - Only approved license families will be returned
  <code>none</code> - No license families will be returned
  </div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLicenseIds(org.apache.rat.license.LicenseSetFactory.LicenseFilter)" class="member-name-link">getLicenseIds</a><wbr>(<a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a>&nbsp;filter)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets the SortedSet of approved license categories.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</a><wbr>&lt;<a href="license/ILicense.html" title="interface in org.apache.rat.license">ILicense</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="#getLicenses(org.apache.rat.license.LicenseSetFactory.LicenseFilter)" class="member-name-link">getLicenses</a><wbr>(<a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a>&nbsp;filter)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets the SortedSet of approved license categories.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="license/LicenseSetFactory.html" title="class in org.apache.rat.license">LicenseSetFactory</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLicenseSetFactory()" class="member-name-link">getLicenseSetFactory</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets the enclosed LicenseSetFactory.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.commons.io.function.IOSupplier<wbr>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</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="#getOutput()" class="member-name-link">getOutput</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the output stream supplier.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="walker/IReportableListWalker.Builder.html" title="class in org.apache.rat.walker">IReportableListWalker.Builder</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSources()" class="member-name-link">getSources</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets a builder initialized with any files specified as sources.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReportConfiguration.Processing.html" title="enum in org.apache.rat">ReportConfiguration.Processing</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStandardProcessing()" class="member-name-link">getStandardProcessing</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Retrieves the archive processing type.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.commons.io.function.IOSupplier<wbr>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStyleSheet()" class="member-name-link">getStyleSheet</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets the IOSupplier with the style sheet.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.commons.io.function.IOSupplier<wbr>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</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="#getWriter()" class="member-name-link">getWriter</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets a PrintWriter that wraps the output stream.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasSource()" class="member-name-link">hasSource</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns <code>true</code> if the configuration has any sources defined.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAddingLicenses()" class="member-name-link">isAddingLicenses</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets the flag that determines if license headers should be added if missing.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAddingLicensesForced()" class="member-name-link">isAddingLicensesForced</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets the flag that determines if license headers are "forced" overwriting existing files.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isDryRun()" class="member-name-link">isDryRun</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the state of the dry run flag.</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="#licenseDuplicateOption(org.apache.rat.utils.ReportingSet.Options)" class="member-name-link">licenseDuplicateOption</a><wbr>(<a href="utils/ReportingSet.Options.html" title="enum in org.apache.rat.utils">ReportingSet.Options</a>&nbsp;state)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the reporting option for duplicate licenses.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listFamilies()" class="member-name-link">listFamilies</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Return the current filter that determines which families will be output in the XML document.</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="#listFamilies(org.apache.rat.license.LicenseSetFactory.LicenseFilter)" class="member-name-link">listFamilies</a><wbr>(<a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a>&nbsp;filter)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Set the level of license families that should be output in the XML document.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listLicenses()" class="member-name-link">listLicenses</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets the selected license filter.</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="#listLicenses(org.apache.rat.license.LicenseSetFactory.LicenseFilter)" class="member-name-link">listLicenses</a><wbr>(<a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a>&nbsp;filter)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Set the level of licenses that should be output in the XML document.</div>
 </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="#logFamilyCollisions(org.apache.rat.utils.Log.Level)" class="member-name-link">logFamilyCollisions</a><wbr>(<a href="utils/Log.Level.html" title="enum in org.apache.rat.utils">Log.Level</a>&nbsp;level)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Set the log level for reporting collisions in the set of license families.</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="#logLicenseCollisions(org.apache.rat.utils.Log.Level)" class="member-name-link">logLicenseCollisions</a><wbr>(<a href="utils/Log.Level.html" title="enum in org.apache.rat.utils">Log.Level</a>&nbsp;level)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the log level for reporting license collisions.</div>
 </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="#removeApprovedLicenseCategories(java.util.Collection)" class="member-name-link">removeApprovedLicenseCategories</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</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;&nbsp;familyCategory)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Removes a license family category from the list of approved licenses.</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="#removeApprovedLicenseCategory(java.lang.String)" class="member-name-link">removeApprovedLicenseCategory</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">
 <div class="block">Adds a license family category to the list of approved licenses.</div>
 </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="#removeApprovedLicenseId(java.lang.String)" class="member-name-link">removeApprovedLicenseId</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;licenseId)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds a license family category to the list of approved licenses.</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="#removeApprovedLicenseIds(java.util.Collection)" class="member-name-link">removeApprovedLicenseIds</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</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;&nbsp;licenseIds)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Removes a license family category from the list of approved licenses.</div>
 </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="#setAddLicenseHeaders(org.apache.rat.config.AddLicenseHeaders)" class="member-name-link">setAddLicenseHeaders</a><wbr>(<a href="config/AddLicenseHeaders.html" title="enum in org.apache.rat.config">AddLicenseHeaders</a>&nbsp;addLicenseHeaders)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets whether RAT should enable, disable, or force the adding of license
  headers.</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="#setArchiveProcessing(org.apache.rat.ReportConfiguration.Processing)" class="member-name-link">setArchiveProcessing</a><wbr>(<a href="ReportConfiguration.Processing.html" title="enum in org.apache.rat">ReportConfiguration.Processing</a>&nbsp;archiveProcessing)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the archive processing type.</div>
 </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="#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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the optional copyright message used if RAT is adding license headers.</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="#setDryRun(boolean)" class="member-name-link">setDryRun</a><wbr>(boolean&nbsp;state)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the dry run flag.</div>
 </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="#setFrom(org.apache.rat.Defaults)" class="member-name-link">setFrom</a><wbr>(<a href="Defaults.html" title="class in org.apache.rat">Defaults</a>&nbsp;defaults)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Adds the licenses and approved licenses from the defaults object to the
  configuration.</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="#setOut(java.io.File)" class="member-name-link">setOut</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;file)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the OutputStream supplier to use the specified file.</div>
 </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="#setOut(org.apache.commons.io.function.IOSupplier)" class="member-name-link">setOut</a><wbr>(org.apache.commons.io.function.IOSupplier&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&gt;&nbsp;out)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the supplier for the output stream.</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="#setStandardProcessing(org.apache.rat.ReportConfiguration.Processing)" class="member-name-link">setStandardProcessing</a><wbr>(<a href="ReportConfiguration.Processing.html" title="enum in org.apache.rat">ReportConfiguration.Processing</a>&nbsp;standardProcessing)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the archive processing type.</div>
 </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="#setStyleSheet(java.io.File)" class="member-name-link">setStyleSheet</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;styleSheet)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the style sheet.</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="#setStyleSheet(java.net.URI)" class="member-name-link">setStyleSheet</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;styleSheet)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the style sheet for custom processing.</div>
 </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="#setStyleSheet(java.net.URL)" class="member-name-link">setStyleSheet</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html" title="class or interface in java.net" class="external-link">URL</a>&nbsp;styleSheet)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the style sheet for custom processing.</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="#setStyleSheet(org.apache.commons.io.function.IOSupplier)" class="member-name-link">setStyleSheet</a><wbr>(org.apache.commons.io.function.IOSupplier&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&gt;&nbsp;styleSheet)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the style sheet for custom processing.</div>
 </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="#validate(java.util.function.Consumer)" class="member-name-link">validate</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</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;&nbsp;logger)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Validates that the configuration is valid.</div>
 </div>
 </div>
 </div>
 </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#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <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>ReportConfiguration</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ReportConfiguration</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="addSource(java.io.File)">
 <h3>addSource</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addSource</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;file)</span></div>
 <div class="block">Adds a file as a source of files to scan.
  The file must be a text file that lists files to be included.
  File within the file must be in linux format with a
  "/" file separator.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>file</code> - the file to process.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addSource(org.apache.rat.report.IReportable)">
 <h3>addSource</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addSource</span><wbr><span class="parameters">(<a href="report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a>&nbsp;reportable)</span></div>
 <div class="block">Adds a Reportable as a source of files to scan.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>reportable</code> - the reportable to process.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="hasSource()">
 <h3>hasSource</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">hasSource</span>()</div>
 <div class="block">Returns <code>true</code> if the configuration has any sources defined.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd><code>true</code> if the configuration has any sources defined.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSources()">
 <h3>getSources</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="walker/IReportableListWalker.Builder.html" title="class in org.apache.rat.walker">IReportableListWalker.Builder</a></span>&nbsp;<span class="element-name">getSources</span>()</div>
 <div class="block">Gets a builder initialized with any files specified as sources.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>a configured builder.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getGeneratedMatcher()">
 <h3>getGeneratedMatcher</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a></span>&nbsp;<span class="element-name">getGeneratedMatcher</span>()</div>
 <div class="block">Gets the matcher that matches generated text.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the matcher that matches generated text.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getArchiveProcessing()">
 <h3>getArchiveProcessing</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ReportConfiguration.Processing.html" title="enum in org.apache.rat">ReportConfiguration.Processing</a></span>&nbsp;<span class="element-name">getArchiveProcessing</span>()</div>
 <div class="block">Retrieves the archive processing type.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>The archive processing type.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setArchiveProcessing(org.apache.rat.ReportConfiguration.Processing)">
 <h3>setArchiveProcessing</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setArchiveProcessing</span><wbr><span class="parameters">(<a href="ReportConfiguration.Processing.html" title="enum in org.apache.rat">ReportConfiguration.Processing</a>&nbsp;archiveProcessing)</span></div>
 <div class="block">Sets the archive processing type. If not set will default to NOTIFICATION.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>archiveProcessing</code> - the type of processing archives should have.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getStandardProcessing()">
 <h3>getStandardProcessing</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ReportConfiguration.Processing.html" title="enum in org.apache.rat">ReportConfiguration.Processing</a></span>&nbsp;<span class="element-name">getStandardProcessing</span>()</div>
 <div class="block">Retrieves the archive processing type.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>The archive processing type.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setStandardProcessing(org.apache.rat.ReportConfiguration.Processing)">
 <h3>setStandardProcessing</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setStandardProcessing</span><wbr><span class="parameters">(<a href="ReportConfiguration.Processing.html" title="enum in org.apache.rat">ReportConfiguration.Processing</a>&nbsp;standardProcessing)</span></div>
 <div class="block">Sets the archive processing type. If not set will default to NOTIFICATION.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>standardProcessing</code> - the type of processing archives should have.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="logFamilyCollisions(org.apache.rat.utils.Log.Level)">
 <h3>logFamilyCollisions</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">logFamilyCollisions</span><wbr><span class="parameters">(<a href="utils/Log.Level.html" title="enum in org.apache.rat.utils">Log.Level</a>&nbsp;level)</span></div>
 <div class="block">Set the log level for reporting collisions in the set of license families.
  <p>NOTE: should be set before licenses or license families are added.</p></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>level</code> - The log level to use.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="familyDuplicateOption(org.apache.rat.utils.ReportingSet.Options)">
 <h3>familyDuplicateOption</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">familyDuplicateOption</span><wbr><span class="parameters">(<a href="utils/ReportingSet.Options.html" title="enum in org.apache.rat.utils">ReportingSet.Options</a>&nbsp;state)</span></div>
 <div class="block">Sets the reporting option for duplicate license families.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>state</code> - The ReportingSet.Option to use for reporting.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="logLicenseCollisions(org.apache.rat.utils.Log.Level)">
 <h3>logLicenseCollisions</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">logLicenseCollisions</span><wbr><span class="parameters">(<a href="utils/Log.Level.html" title="enum in org.apache.rat.utils">Log.Level</a>&nbsp;level)</span></div>
 <div class="block">Sets the log level for reporting license collisions.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>level</code> - The log level.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="licenseDuplicateOption(org.apache.rat.utils.ReportingSet.Options)">
 <h3>licenseDuplicateOption</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">licenseDuplicateOption</span><wbr><span class="parameters">(<a href="utils/ReportingSet.Options.html" title="enum in org.apache.rat.utils">ReportingSet.Options</a>&nbsp;state)</span></div>
 <div class="block">Sets the reporting option for duplicate licenses.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>state</code> - the ReportingSt.Option to use for reporting.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="listFamilies(org.apache.rat.license.LicenseSetFactory.LicenseFilter)">
 <h3>listFamilies</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">listFamilies</span><wbr><span class="parameters">(<a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a>&nbsp;filter)</span></div>
 <div class="block">Set the level of license families that should be output in the XML document.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>filter</code> - the license families to list.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="listFamilies()">
 <h3>listFamilies</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a></span>&nbsp;<span class="element-name">listFamilies</span>()</div>
 <div class="block">Return the current filter that determines which families will be output in the XML document.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the filter that defines the families to list.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="listLicenses(org.apache.rat.license.LicenseSetFactory.LicenseFilter)">
 <h3>listLicenses</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">listLicenses</span><wbr><span class="parameters">(<a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a>&nbsp;filter)</span></div>
 <div class="block">Set the level of licenses that should be output in the XML document.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>filter</code> - the licenses to list.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="listLicenses()">
 <h3>listLicenses</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a></span>&nbsp;<span class="element-name">listLicenses</span>()</div>
 <div class="block">Gets the selected license filter.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the filter to limit license display.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setDryRun(boolean)">
 <h3>setDryRun</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setDryRun</span><wbr><span class="parameters">(boolean&nbsp;state)</span></div>
 <div class="block">Sets the dry run flag.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>state</code> - the state for the dry run flag.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="isDryRun()">
 <h3>isDryRun</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isDryRun</span>()</div>
 <div class="block">Returns the state of the dry run flag.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the state of the dry run flag.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addExcludedCollection(org.apache.rat.config.exclusion.StandardCollection)">
 <h3>addExcludedCollection</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addExcludedCollection</span><wbr><span class="parameters">(<a href="config/exclusion/StandardCollection.html" title="enum in org.apache.rat.config.exclusion">StandardCollection</a>&nbsp;collection)</span></div>
 <div class="block">Excludes a StandardCollection of patterns.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>collection</code> - the StandardCollection to exclude.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list-long">
 <li><a href="config/exclusion/ExclusionProcessor.html#addExcludedCollection(org.apache.rat.config.exclusion.StandardCollection)"><code>ExclusionProcessor.addExcludedCollection(StandardCollection)</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addExcludedFileProcessor(org.apache.rat.config.exclusion.StandardCollection)">
 <h3>addExcludedFileProcessor</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addExcludedFileProcessor</span><wbr><span class="parameters">(<a href="config/exclusion/StandardCollection.html" title="enum in org.apache.rat.config.exclusion">StandardCollection</a>&nbsp;collection)</span></div>
 <div class="block">Excludes the file processor defined in the StandardCollection.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>collection</code> - the StandardCollection to exclude.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list-long">
 <li><a href="config/exclusion/ExclusionProcessor.html#addFileProcessor(org.apache.rat.config.exclusion.StandardCollection)"><code>ExclusionProcessor.addFileProcessor(StandardCollection)</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addExcludedFilter(java.io.FileFilter)">
 <h3>addExcludedFilter</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addExcludedFilter</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileFilter.html" title="class or interface in java.io" class="external-link">FileFilter</a>&nbsp;fileFilter)</span></div>
 <div class="block">Excludes files that match a FileFilter.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>fileFilter</code> - the file filter to match.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addExcludedMatcher(org.apache.rat.document.DocumentNameMatcher)">
 <h3>addExcludedMatcher</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addExcludedMatcher</span><wbr><span class="parameters">(<a href="document/DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>&nbsp;matcher)</span></div>
 <div class="block">Excludes files that match a DocumentNameMatcher.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>matcher</code> - the DocumentNameMatcher to match.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addExcludedPatterns(java.lang.Iterable)">
 <h3>addExcludedPatterns</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addExcludedPatterns</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</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;&nbsp;patterns)</span></div>
 <div class="block">Excludes files that match the pattern.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>patterns</code> - the collection of patterns to exclude.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list-long">
 <li><a href="config/exclusion/ExclusionProcessor.html#addIncludedPatterns(java.lang.Iterable)"><code>ExclusionProcessor.addIncludedPatterns(Iterable)</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addIncludedCollection(org.apache.rat.config.exclusion.StandardCollection)">
 <h3>addIncludedCollection</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addIncludedCollection</span><wbr><span class="parameters">(<a href="config/exclusion/StandardCollection.html" title="enum in org.apache.rat.config.exclusion">StandardCollection</a>&nbsp;collection)</span></div>
 <div class="block">Adds the patterns from the standard collection as included patterns.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>collection</code> - the standard collection to include.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addIncludedFilter(java.io.FileFilter)">
 <h3>addIncludedFilter</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addIncludedFilter</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileFilter.html" title="class or interface in java.io" class="external-link">FileFilter</a>&nbsp;fileFilter)</span></div>
 <div class="block">Adds the fileFilter to filter files that should be included, this overrides any
  exclusion of the same files.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>fileFilter</code> - the filter to identify files that should be included.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addIncludedPatterns(java.lang.Iterable)">
 <h3>addIncludedPatterns</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addIncludedPatterns</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</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;&nbsp;patterns)</span></div>
 <div class="block">Add file patterns that are to be included. These patterns override any exclusion of
  the same files.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>patterns</code> - The iterable of Strings containing the patterns.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getDocumentExcluder(org.apache.rat.document.DocumentName)">
 <h3>getDocumentExcluder</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="document/DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></span>&nbsp;<span class="element-name">getDocumentExcluder</span><wbr><span class="parameters">(<a href="document/DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>&nbsp;baseDir)</span></div>
 <div class="block">Get the DocumentNameMatcher that excludes files found in the directory tree..</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>baseDir</code> - the DocumentName for the base directory.</dd>
 <dt>Returns:</dt>
 <dd>the DocumentNameMatcher for the base directory.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getStyleSheet()">
 <h3>getStyleSheet</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">org.apache.commons.io.function.IOSupplier&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&gt;</span>&nbsp;<span class="element-name">getStyleSheet</span>()</div>
 <div class="block">Gets the IOSupplier with the style sheet.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the Supplier of the InputStream that is the XSLT style sheet to style
  the report with.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setStyleSheet(org.apache.commons.io.function.IOSupplier)">
 <h3>setStyleSheet</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setStyleSheet</span><wbr><span class="parameters">(org.apache.commons.io.function.IOSupplier&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&gt;&nbsp;styleSheet)</span></div>
 <div class="block">Sets the style sheet for custom processing. The IOSupplier may be called
  multiple times, so the input stream must be able to be opened and closed
  multiple times.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>styleSheet</code> - the XSLT style sheet to style the report with.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setFrom(org.apache.rat.Defaults)">
 <h3>setFrom</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setFrom</span><wbr><span class="parameters">(<a href="Defaults.html" title="class in org.apache.rat">Defaults</a>&nbsp;defaults)</span></div>
 <div class="block">Adds the licenses and approved licenses from the defaults object to the
  configuration. <em>Side effect:</em> if the report should be styled and no
  style sheet has been set the plain stylesheet from the defaults will be used.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>defaults</code> - The defaults to set.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setStyleSheet(java.io.File)">
 <h3>setStyleSheet</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setStyleSheet</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;styleSheet)</span></div>
 <div class="block">Sets the style sheet.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>styleSheet</code> - the XSLT style sheet file to style the report with.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setStyleSheet(java.net.URI)">
 <h3>setStyleSheet</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setStyleSheet</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;styleSheet)</span></div>
 <div class="block">Sets the style sheet for custom processing. The stylesheet may be opened
  multiple times so the URI must be capable of being opened multiple times.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>styleSheet</code> - the URI of the XSLT style sheet to style the report with.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setStyleSheet(java.net.URL)">
 <h3>setStyleSheet</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setStyleSheet</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html" title="class or interface in java.net" class="external-link">URL</a>&nbsp;styleSheet)</span></div>
 <div class="block">Sets the style sheet for custom processing. The stylesheet may be opened
  multiple times so the URL must be capable of being opened multiple times.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>styleSheet</code> - the URL of the XSLT style sheet to style the report with.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setOut(org.apache.commons.io.function.IOSupplier)">
 <h3>setOut</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setOut</span><wbr><span class="parameters">(org.apache.commons.io.function.IOSupplier&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&gt;&nbsp;out)</span></div>
 <div class="block">Sets the supplier for the output stream. The supplier may be called multiple
  times to provide the stream. Suppliers should prepare streams that are
  appended to and that can be closed. If an <code>OutputStream</code> should not be
  closed consider wrapping it in a <code>NoCloseOutputStream</code></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>out</code> - The OutputStream supplier that provides the output stream to write
  the report to. A null value will use System.out.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list-long">
 <li><a href="ReportConfiguration.NoCloseOutputStream.html" title="class in org.apache.rat"><code>ReportConfiguration.NoCloseOutputStream</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setOut(java.io.File)">
 <h3>setOut</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setOut</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;file)</span></div>
 <div class="block">Sets the OutputStream supplier to use the specified file. The file may be
  opened and closed several times. File is deleted first and then may be
  repeatedly opened in append mode.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>file</code> - The file to create the supplier with.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list">
 <li><a href="#setOut(org.apache.commons.io.function.IOSupplier)"><code>setOut(IOSupplier)</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getOutput()">
 <h3>getOutput</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">org.apache.commons.io.function.IOSupplier&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&gt;</span>&nbsp;<span class="element-name">getOutput</span>()</div>
 <div class="block">Returns the output stream supplier. If no stream has been set returns a
  supplier for System.out.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>The supplier of the output stream to write the report to.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getWriter()">
 <h3>getWriter</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">org.apache.commons.io.function.IOSupplier&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a>&gt;</span>&nbsp;<span class="element-name">getWriter</span>()</div>
 <div class="block">Gets a PrintWriter that wraps the output stream.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>A supplier for a PrintWriter that wraps the output stream.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list">
 <li><a href="#getOutput()"><code>getOutput()</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addLicense(org.apache.rat.license.ILicense)">
 <h3>addLicense</h3>
 <div class="member-signature"><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/ILicense.html" title="interface in org.apache.rat.license">ILicense</a>&nbsp;license)</span></div>
 <div class="block">Adds a license to the list of licenses. Does not add the license to the list
  of approved licenses.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>license</code> - The license to add to the list of licenses.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addLicense(org.apache.rat.license.ILicense.Builder)">
 <h3>addLicense</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a></span>&nbsp;<span class="element-name">addLicense</span><wbr><span class="parameters">(<a href="license/ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a>&nbsp;builder)</span></div>
 <div class="block">Adds a license to the list of licenses. Does not add the license to the list
  of approved licenses.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>builder</code> - The license builder to build and add to the list of licenses.</dd>
 <dt>Returns:</dt>
 <dd>The ILicense implementation that was added.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addLicenses(java.util.Collection)">
 <h3>addLicenses</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addLicenses</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a>&gt;&nbsp;licenses)</span></div>
 <div class="block">Adds multiple licenses to the list of licenses. Does not add the licenses to
  the list of approved licenses.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>licenses</code> - The licenses to add.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addFamily(org.apache.rat.license.ILicenseFamily)">
 <h3>addFamily</h3>
 <div class="member-signature"><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="license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>&nbsp;family)</span></div>
 <div class="block">Adds a license family to the list of families. Does not add the family to the
  list of approved licenses.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>family</code> - The license family to add to the list of license families.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addFamily(org.apache.rat.license.ILicenseFamily.Builder)">
 <h3>addFamily</h3>
 <div class="member-signature"><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="license/ILicenseFamily.Builder.html" title="class in org.apache.rat.license">ILicenseFamily.Builder</a>&nbsp;builder)</span></div>
 <div class="block">Adds a license family to the list of families. Does not add the family to the
  list of approved licenses.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>builder</code> - The licenseFamily.Builder to build and add to the list of
  licenses.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addFamilies(java.util.Collection)">
 <h3>addFamilies</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addFamilies</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>&gt;&nbsp;families)</span></div>
 <div class="block">Adds multiple families to the list of license families. Does not add the
  licenses to the list of approved licenses.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>families</code> - The license families to add.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addApprovedLicenseCategory(org.apache.rat.license.ILicenseFamily)">
 <h3>addApprovedLicenseCategory</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addApprovedLicenseCategory</span><wbr><span class="parameters">(<a href="license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>&nbsp;approvedILicenseFamily)</span></div>
 <div class="block">Adds an ILicenseFamily to the list of approved licenses.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>approvedILicenseFamily</code> - the LicenseFamily to add.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addApprovedLicenseCategory(java.lang.String)">
 <h3>addApprovedLicenseCategory</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addApprovedLicenseCategory</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="block">Adds a license family category (id) 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="addApprovedLicenseCategories(java.util.Collection)">
 <h3>addApprovedLicenseCategories</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addApprovedLicenseCategories</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</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;&nbsp;approvedLicenseCategories)</span></div>
 <div class="block">Adds a collection of license family categories to the set of approved license
  names.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>approvedLicenseCategories</code> - set of approved license categories.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="removeApprovedLicenseCategory(java.lang.String)">
 <h3>removeApprovedLicenseCategory</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">removeApprovedLicenseCategory</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="block">Adds a license family category to the list of approved licenses. <em>Once a
  license has been removed from the approved list it cannot be re-added</em></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>familyCategory</code> - the category to add.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="removeApprovedLicenseCategories(java.util.Collection)">
 <h3>removeApprovedLicenseCategories</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">removeApprovedLicenseCategories</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</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;&nbsp;familyCategory)</span></div>
 <div class="block">Removes a license family category from the list of approved licenses.
  <em>Once a license has been removed from the approved list it cannot be
  re-added</em></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>familyCategory</code> - the family category to remove.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getLicenseCategories(org.apache.rat.license.LicenseSetFactory.LicenseFilter)">
 <h3>getLicenseCategories</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</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">getLicenseCategories</span><wbr><span class="parameters">(<a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a>&nbsp;filter)</span></div>
 <div class="block">Gets the SortedSet of approved license categories. <em>Once a license has
  been removed from the approved list it cannot be re-added</em></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>filter</code> - The LicenseFilter to filter the categories by.</dd>
 <dt>Returns:</dt>
 <dd>the Sorted set of approved license categories.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getLicenses(org.apache.rat.license.LicenseSetFactory.LicenseFilter)">
 <h3>getLicenses</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</a>&lt;<a href="license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a>&gt;</span>&nbsp;<span class="element-name">getLicenses</span><wbr><span class="parameters">(<a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a>&nbsp;filter)</span></div>
 <div class="block">Gets the SortedSet of approved license categories. <em>Once a license has
  been removed from the approved list it cannot be re-added</em></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>filter</code> - The LicenseFilter to filter the licenses by.</dd>
 <dt>Returns:</dt>
 <dd>the Sorted set of approved license categories.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getLicenseIds(org.apache.rat.license.LicenseSetFactory.LicenseFilter)">
 <h3>getLicenseIds</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</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">getLicenseIds</span><wbr><span class="parameters">(<a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a>&nbsp;filter)</span></div>
 <div class="block">Gets the SortedSet of approved license categories. <em>Once a license has
  been removed from the approved list it cannot be re-added</em></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>filter</code> - The LicenseFilter to filter the licenses by.</dd>
 <dt>Returns:</dt>
 <dd>the Sorted set of approved license categories.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addApprovedLicenseId(org.apache.rat.license.ILicense)">
 <h3>addApprovedLicenseId</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addApprovedLicenseId</span><wbr><span class="parameters">(<a href="license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a>&nbsp;approvedLicense)</span></div>
 <div class="block">Adds an ILicenseFamily to the list of approved licenses.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>approvedLicense</code> - the License to add.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addApprovedLicenseId(java.lang.String)">
 <h3>addApprovedLicenseId</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addApprovedLicenseId</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;licenseId)</span></div>
 <div class="block">Adds a license family category (id) to the list of approved licenses</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>licenseId</code> - the license id to add.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addApprovedLicenseIds(java.util.Collection)">
 <h3>addApprovedLicenseIds</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addApprovedLicenseIds</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</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;&nbsp;approvedLicenseIds)</span></div>
 <div class="block">Adds a collection of license family categories to the set of approved license
  names.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>approvedLicenseIds</code> - set of approved license IDs.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="removeApprovedLicenseId(java.lang.String)">
 <h3>removeApprovedLicenseId</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">removeApprovedLicenseId</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;licenseId)</span></div>
 <div class="block">Adds a license family category to the list of approved licenses. <em>Once a
  license has been removed from the approved list it cannot be re-added</em></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>licenseId</code> - the license ID to add.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="removeApprovedLicenseIds(java.util.Collection)">
 <h3>removeApprovedLicenseIds</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">removeApprovedLicenseIds</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</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;&nbsp;licenseIds)</span></div>
 <div class="block">Removes a license family category from the list of approved licenses.
  <em>Once a license has been removed from the approved list it cannot be
  re-added</em></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>licenseIds</code> - the license IDs to remove.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getCopyrightMessage()">
 <h3>getCopyrightMessage</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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></span>&nbsp;<span class="element-name">getCopyrightMessage</span>()</div>
 <div class="block">Returns the optional license copyright being added if RAT is adding headers.
  This value is ignored, if no license headers are added.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the optional copyright message.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list">
 <li><a href="#isAddingLicenses()"><code>isAddingLicenses()</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setCopyrightMessage(java.lang.String)">
 <h3>setCopyrightMessage</h3>
 <div class="member-signature"><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="block">Sets the optional copyright message used if RAT is adding license headers.
  This value is ignored, if no license headers are added.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>copyrightMessage</code> - message to set.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list">
 <li><a href="#isAddingLicenses()"><code>isAddingLicenses()</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="isAddingLicensesForced()">
 <h3>isAddingLicensesForced</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isAddingLicensesForced</span>()</div>
 <div class="block">Gets the flag that determines if license headers are "forced" overwriting existing files.
  This value is ignored if RAT is not adding licenses.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd><code>true</code> if RAT is forcing the adding license headers.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list">
 <li><a href="#isAddingLicenses()"><code>isAddingLicenses()</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="isAddingLicenses()">
 <h3>isAddingLicenses</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isAddingLicenses</span>()</div>
 <div class="block">Gets the flag that determines if license headers should be added if missing.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>whether RAT should add missing license headers.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list">
 <li><a href="#isAddingLicensesForced()"><code>isAddingLicensesForced()</code></a></li>
 <li><a href="#getCopyrightMessage()"><code>getCopyrightMessage()</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setAddLicenseHeaders(org.apache.rat.config.AddLicenseHeaders)">
 <h3>setAddLicenseHeaders</h3>
 <div class="member-signature"><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="config/AddLicenseHeaders.html" title="enum in org.apache.rat.config">AddLicenseHeaders</a>&nbsp;addLicenseHeaders)</span></div>
 <div class="block">Sets whether RAT should enable, disable, or force the adding of license
  headers.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>addLicenseHeaders</code> - enables/disables or forces adding of licenses
  headers.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list">
 <li><a href="#isAddingLicenses()"><code>isAddingLicenses()</code></a></li>
 <li><a href="#setCopyrightMessage(java.lang.String)"><code>setCopyrightMessage(String)</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getLicenseFamilies(org.apache.rat.license.LicenseSetFactory.LicenseFilter)">
 <h3>getLicenseFamilies</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</a>&lt;<a href="license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>&gt;</span>&nbsp;<span class="element-name">getLicenseFamilies</span><wbr><span class="parameters">(<a href="license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a>&nbsp;filter)</span></div>
 <div class="block">Gets a sorted set of ILicenseFamily objects based on <code>filter</code>. if
  filter is set:
  <ul>
  <li><code>all</code> - All licenses families will be returned.</li>
  <li><code>approved</code> - Only approved license families will be returned</li>
  <li><code>none</code> - No license families will be returned</li>
  </ul></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>filter</code> - The license filter.</dd>
 <dt>Returns:</dt>
 <dd>The set of defined licenses.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getClaimValidator()">
 <h3>getClaimValidator</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="config/results/ClaimValidator.html" title="class in org.apache.rat.config.results">ClaimValidator</a></span>&nbsp;<span class="element-name">getClaimValidator</span>()</div>
 <div class="block">Gets the ClaimValidator for the configuration.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the ClaimValidator.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getLicenseSetFactory()">
 <h3>getLicenseSetFactory</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="license/LicenseSetFactory.html" title="class in org.apache.rat.license">LicenseSetFactory</a></span>&nbsp;<span class="element-name">getLicenseSetFactory</span>()</div>
 <div class="block">Gets the enclosed LicenseSetFactory.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the license set factory.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="validate(java.util.function.Consumer)">
 <h3>validate</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">validate</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</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;&nbsp;logger)</span></div>
 <div class="block">Validates that the configuration is valid.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>logger</code> - String consumer to log warning messages to.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="ConfigurationException.html" title="class in org.apache.rat">ConfigurationException</a></code> - on configuration error.</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>