Google Git
Sign in
apache / creadur-site / HEAD / . / rat0161 / apidocs / org / apache / rat / ReportConfiguration.html
blob: 95f343a6ebded5f9b77b8179c3516458cdf8ceed [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (16) -->
<title>ReportConfiguration (Apache Creadur Rat 0.16.1-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">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.5.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 evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
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">
<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">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<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"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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="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 front ends 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><span class="member-name-link"><a href="ReportConfiguration.NoCloseOutputStream.html" title="class in org.apache.rat">ReportConfiguration.NoCloseOutputStream</a></span></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>
</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><span class="member-name-link"><a href="#%3Cinit%3E(org.apache.rat.utils.Log)">ReportConfiguration</a></span>&#8203;(<a href="utils/Log.html" title="interface in org.apache.rat.utils">Log</a>&nbsp;log)</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-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#addApprovedLicenseCategories(java.util.Collection)">addApprovedLicenseCategories</a></span>&#8203;(<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-tab2 method-summary-table-tab4 method-summary-table">
<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-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#addApprovedLicenseCategory(java.lang.String)">addApprovedLicenseCategory</a></span>&#8203;(<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-tab2 method-summary-table-tab4 method-summary-table">
<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-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#addApprovedLicenseCategory(org.apache.rat.license.ILicenseFamily)">addApprovedLicenseCategory</a></span>&#8203;(<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-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Adds an ILicenseFamily to the list of approved licenses.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#addDirectoryFilter(org.apache.commons.io.filefilter.IOFileFilter)">addDirectoryFilter</a></span>&#8203;(org.apache.commons.io.filefilter.IOFileFilter&nbsp;directoryFilter)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#addFamilies(java.util.Collection)">addFamilies</a></span>&#8203;(<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 even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Adds multiple families to the list of license families.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#addFamily(org.apache.rat.license.ILicenseFamily)">addFamily</a></span>&#8203;(<a href="license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>&nbsp;family)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Adds a license family to the list of families.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#addFamily(org.apache.rat.license.ILicenseFamily.Builder)">addFamily</a></span>&#8203;(<a href="license/ILicenseFamily.Builder.html" title="interface in org.apache.rat.license">ILicenseFamily.Builder</a>&nbsp;builder)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Adds a license family to the list of families.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#addLicense(org.apache.rat.license.ILicense)">addLicense</a></span>&#8203;(<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-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Adds a license to the list of licenses.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><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-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#addLicense(org.apache.rat.license.ILicense.Builder)">addLicense</a></span>&#8203;(<a href="license/ILicense.Builder.html" title="class in org.apache.rat.license">ILicense.Builder</a>&nbsp;builder)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Adds a license to the list of licenses.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#addLicenses(java.util.Collection)">addLicenses</a></span>&#8203;(<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-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Adds multiple licenses to the list of licenses.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#addLicensesIfNotPresent(java.util.Collection)">addLicensesIfNotPresent</a></span>&#8203;(<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 even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Adds multiple licenses to the list of licenses.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#familyDuplicateOption(org.apache.rat.utils.ReportingSet.Options)">familyDuplicateOption</a></span>&#8203;(<a href="utils/ReportingSet.Options.html" title="enum in org.apache.rat.utils">ReportingSet.Options</a>&nbsp;state)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Sets the reporting option for duplicate license families.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><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>&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-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getApprovedLicenseCategories()">getApprovedLicenseCategories</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Gets the SortedSet of approved license categories.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><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-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getCopyrightMessage()">getCopyrightMessage</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<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-tab2 method-summary-table-tab4 method-summary-table"><code>org.apache.commons.io.filefilter.IOFileFilter</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getDirectoryFilter()">getDirectoryFilter</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FilenameFilter.html" title="class or interface in java.io" class="external-link">FilenameFilter</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getInputFileFilter()">getInputFileFilter</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><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>&lt;<a href="license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getLicenseFamilies(org.apache.rat.license.LicenseSetFactory.LicenseFilter)">getLicenseFamilies</a></span>&#8203;(<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-tab2 method-summary-table-tab4 method-summary-table">
<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 odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><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>&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-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getLicenses(org.apache.rat.license.LicenseSetFactory.LicenseFilter)">getLicenses</a></span>&#8203;(<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-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Gets a set Licenses of depending on the <code>filter</code> if filter is set:
<code>all</code> - All licenses will be returned.
<code>approved</code> - Only approved licenses will be returned
<code>none</code> - No licenses will be returned
</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="utils/Log.html" title="interface in org.apache.rat.utils">Log</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getLog()">getLog</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Retrieves the Log that was provided in the constructor.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>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;</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getOutput()">getOutput</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Returns the output stream supplier.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getReportable()">getReportable</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>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;</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getStyleSheet()">getStyleSheet</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>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;</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getWriter()">getWriter</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#isAddingLicenses()">isAddingLicenses</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#isAddingLicensesForced()">isAddingLicensesForced</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">This value is ignored if RAT is not adding licenses.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#isStyleReport()">isStyleReport</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#licenseDuplicateOption(org.apache.rat.utils.ReportingSet.Options)">licenseDuplicateOption</a></span>&#8203;(<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-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Sets the reporting option for duplicate licenses.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#logFamilyCollisions(org.apache.rat.utils.Log.Level)">logFamilyCollisions</a></span>&#8203;(<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-tab2 method-summary-table-tab4 method-summary-table">
<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-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#logLicenseCollisions(org.apache.rat.utils.Log.Level)">logLicenseCollisions</a></span>&#8203;(<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-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Sets the log level for reporting license collisions.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#removeApprovedLicenseCategories(java.util.Collection)">removeApprovedLicenseCategories</a></span>&#8203;(<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-tab2 method-summary-table-tab4 method-summary-table">
<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-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#removeApprovedLicenseCategory(java.lang.String)">removeApprovedLicenseCategory</a></span>&#8203;(<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-tab2 method-summary-table-tab4 method-summary-table">
<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-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setAddLicenseHeaders(org.apache.rat.config.AddLicenseHeaders)">setAddLicenseHeaders</a></span>&#8203;(<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-tab2 method-summary-table-tab4 method-summary-table">
<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-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setCopyrightMessage(java.lang.String)">setCopyrightMessage</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;copyrightMessage)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Sets the optional copyright message used if RAT is adding license headers.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setDirectoryFilter(org.apache.commons.io.filefilter.IOFileFilter)">setDirectoryFilter</a></span>&#8203;(org.apache.commons.io.filefilter.IOFileFilter&nbsp;directoryFilter)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setFrom(org.apache.rat.Defaults)">setFrom</a></span>&#8203;(<a href="Defaults.html" title="class in org.apache.rat">Defaults</a>&nbsp;defaults)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Adds the licenses and approved licenses from the defaults object to the
configuration.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setInputFileFilter(java.io.FilenameFilter)">setInputFileFilter</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/FilenameFilter.html" title="class or interface in java.io" class="external-link">FilenameFilter</a>&nbsp;inputFileFilter)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setOut(java.io.File)">setOut</a></span>&#8203;(<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-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Sets the OutputStream supplier to use the specified file.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setOut(org.apache.commons.io.function.IOSupplier)">setOut</a></span>&#8203;(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-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Sets the supplier for the output stream.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setReportable(org.apache.rat.report.IReportable)">setReportable</a></span>&#8203;(<a href="report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a>&nbsp;reportable)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setStyleReport(boolean)">setStyleReport</a></span>&#8203;(boolean&nbsp;styleReport)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setStyleSheet(java.io.File)">setStyleSheet</a></span>&#8203;(<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 even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setStyleSheet(java.net.URI)">setStyleSheet</a></span>&#8203;(<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 odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Sets the style sheet for custom processing.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setStyleSheet(java.net.URL)">setStyleSheet</a></span>&#8203;(<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 even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Sets the style sheet for custom processing.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setStyleSheet(org.apache.commons.io.function.IOSupplier)">setStyleSheet</a></span>&#8203;(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 odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Sets the style sheet for custom processing.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#validate(java.util.function.Consumer)">validate</a></span>&#8203;(<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 even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<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;(org.apache.rat.utils.Log)">
<h3>ReportConfiguration</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ReportConfiguration</span>&#8203;<span class="parameters">(<a href="utils/Log.html" title="interface in org.apache.rat.utils">Log</a>&nbsp;log)</span></div>
<div class="block">Constructor</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>log</code> - The Log implementation that messages will be written to.</dd>
</dl>
</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="getLog()">
<h3>getLog</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="utils/Log.html" title="interface in org.apache.rat.utils">Log</a></span>&nbsp;<span class="element-name">getLog</span>()</div>
<div class="block">Retrieves the Log that was provided in the constructor.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the Log for the system.</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>&#8203;<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>&#8203;<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>&#8203;<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>&#8203;<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="getInputFileFilter()">
<h3>getInputFileFilter</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/io/FilenameFilter.html" title="class or interface in java.io" class="external-link">FilenameFilter</a></span>&nbsp;<span class="element-name">getInputFileFilter</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The filename filter for the potential input files.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setInputFileFilter(java.io.FilenameFilter)">
<h3>setInputFileFilter</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setInputFileFilter</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/FilenameFilter.html" title="class or interface in java.io" class="external-link">FilenameFilter</a>&nbsp;inputFileFilter)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>inputFileFilter</code> - the filename filter to filter the input files.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDirectoryFilter()">
<h3>getDirectoryFilter</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">org.apache.commons.io.filefilter.IOFileFilter</span>&nbsp;<span class="element-name">getDirectoryFilter</span>()</div>
</section>
</li>
<li>
<section class="detail" id="setDirectoryFilter(org.apache.commons.io.filefilter.IOFileFilter)">
<h3>setDirectoryFilter</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setDirectoryFilter</span>&#8203;<span class="parameters">(org.apache.commons.io.filefilter.IOFileFilter&nbsp;directoryFilter)</span></div>
</section>
</li>
<li>
<section class="detail" id="addDirectoryFilter(org.apache.commons.io.filefilter.IOFileFilter)">
<h3>addDirectoryFilter</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addDirectoryFilter</span>&#8203;<span class="parameters">(org.apache.commons.io.filefilter.IOFileFilter&nbsp;directoryFilter)</span></div>
</section>
</li>
<li>
<section class="detail" id="getReportable()">
<h3>getReportable</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a></span>&nbsp;<span class="element-name">getReportable</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the thing being reported on.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setReportable(org.apache.rat.report.IReportable)">
<h3>setReportable</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setReportable</span>&#8203;<span class="parameters">(<a href="report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a>&nbsp;reportable)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>reportable</code> - the thing being reported on.</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>
<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>&#8203;<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>&#8203;<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>&#8203;<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>
<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="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>&#8203;<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>&#8203;<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="isStyleReport()">
<h3>isStyleReport</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isStyleReport</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if the XML report should be styled.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setStyleReport(boolean)">
<h3>setStyleReport</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setStyleReport</span>&#8203;<span class="parameters">(boolean&nbsp;styleReport)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>styleReport</code> - specifies whether the XML report should be styled.</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>&#8203;<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><a href="ReportConfiguration.NoCloseOutputStream.html" title="class in org.apache.rat"><code>ReportConfiguration.NoCloseOutputStream</code></a></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>&#8203;<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><a href="#setOut(org.apache.commons.io.function.IOSupplier)"><code>setOut(IOSupplier)</code></a></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>
<dl class="notes">
<dt>Returns:</dt>
<dd>A supplier for a PrintWriter that wraps the output stream.</dd>
<dt>See Also:</dt>
<dd><a href="#getOutput()"><code>getOutput()</code></a></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>&#8203;<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>&#8203;<span class="parameters">(<a href="license/ILicense.Builder.html" title="class 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>
</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>&#8203;<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="addLicensesIfNotPresent(java.util.Collection)">
<h3>addLicensesIfNotPresent</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addLicensesIfNotPresent</span>&#8203;<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>&#8203;<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>&#8203;<span class="parameters">(<a href="license/ILicenseFamily.Builder.html" title="interface 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>&#8203;<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>&#8203;<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>&#8203;<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>&#8203;<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>&#8203;<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>&#8203;<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="getApprovedLicenseCategories()">
<h3>getApprovedLicenseCategories</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">getApprovedLicenseCategories</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>Returns:</dt>
<dd>the Sorted set of approved license categories.</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><a href="#isAddingLicenses()"><code>isAddingLicenses()</code></a></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>&#8203;<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><a href="#isAddingLicenses()"><code>isAddingLicenses()</code></a></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">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><a href="#isAddingLicenses()"><code>isAddingLicenses()</code></a></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>
<dl class="notes">
<dt>Returns:</dt>
<dd>whether RAT should add missing license headers.</dd>
<dt>See Also:</dt>
<dd><a href="#isAddingLicensesForced()"><code>isAddingLicensesForced()</code></a>,
<a href="#getCopyrightMessage()"><code>getCopyrightMessage()</code></a></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>&#8203;<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><a href="#isAddingLicenses()"><code>isAddingLicenses()</code></a>,
<a href="#setCopyrightMessage(java.lang.String)"><code>setCopyrightMessage(String)</code></a></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>&#8203;<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 set Licenses of depending on the <code>filter</code> if filter is set:
<ul>
<li><code>all</code> - All licenses will be returned.</li>
<li><code>approved</code> - Only approved licenses will be returned</li>
<li><code>none</code> - No licenses 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="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>&#8203;<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="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>&#8203;<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>
</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;2023 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>