| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ReportConfiguration (Apache Creadur Rat 0.16 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ReportConfiguration (Apache Creadur Rat 0.16 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../org/apache/rat/Report.html" title="class in org.apache.rat"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/rat/ReportConfiguration.NoCloseOutputStream.html" title="class in org.apache.rat"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/rat/ReportConfiguration.html" target="_top">Frames</a></li> |
| <li><a href="ReportConfiguration.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <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> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.rat</div> |
| <h2 title="Class ReportConfiguration" class="title">Class ReportConfiguration</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.rat.ReportConfiguration</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ReportConfiguration</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">A configuration object is used by the front end to invoke the |
| <a href="../../../org/apache/rat/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="../../../org/apache/rat/Reporter.html" title="class in org.apache.rat"><code>Reporter</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.NoCloseOutputStream.html" title="class in org.apache.rat">ReportConfiguration.NoCloseOutputStream</a></span></code> |
| <div class="block">A wrapper around an output stream that does not close the output stream.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#ReportConfiguration--">ReportConfiguration</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#addApprovedLicenseCategories-java.util.Collection-">addApprovedLicenseCategories</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> approvedLicenseCategories)</code> |
| <div class="block">Adds a collection of license family categories to the set of approved license |
| names.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#addApprovedLicenseCategory-org.apache.rat.license.ILicenseFamily-">addApprovedLicenseCategory</a></span>(<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a> approvedILicenseFamily)</code> |
| <div class="block">Adds an ILicenseFamily to the list of approved licenses.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#addApprovedLicenseCategory-java.lang.String-">addApprovedLicenseCategory</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> familyCategory)</code> |
| <div class="block">Adds a license family category (id) to the list of approved licenses</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#addDirectoryFilter-org.apache.commons.io.filefilter.IOFileFilter-">addDirectoryFilter</a></span>(org.apache.commons.io.filefilter.IOFileFilter directoryFilter)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#addFamilies-java.util.Collection-">addFamilies</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>> families)</code> |
| <div class="block">Adds multiple families to the list of license families.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#addFamily-org.apache.rat.license.ILicenseFamily.Builder-">addFamily</a></span>(<a href="../../../org/apache/rat/license/ILicenseFamily.Builder.html" title="interface in org.apache.rat.license">ILicenseFamily.Builder</a> builder)</code> |
| <div class="block">Adds a license family to the list of families.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#addFamily-org.apache.rat.license.ILicenseFamily-">addFamily</a></span>(<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a> family)</code> |
| <div class="block">Adds a license family to the list of families.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/rat/license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#addLicense-org.apache.rat.license.ILicense.Builder-">addLicense</a></span>(<a href="../../../org/apache/rat/license/ILicense.Builder.html" title="class in org.apache.rat.license">ILicense.Builder</a> builder)</code> |
| <div class="block">Adds a license to the list of licenses.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#addLicense-org.apache.rat.license.ILicense-">addLicense</a></span>(<a href="../../../org/apache/rat/license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a> license)</code> |
| <div class="block">Adds a license to the list of licenses.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#addLicenses-java.util.Collection-">addLicenses</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../org/apache/rat/license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a>> licenses)</code> |
| <div class="block">Adds multiple licenses to the list of licenses.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#getApprovedLicenseCategories--">getApprovedLicenseCategories</a></span>()</code> |
| <div class="block">Gets the SortedSet of approved license categories.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#getCopyrightMessage--">getCopyrightMessage</a></span>()</code> |
| <div class="block">Returns the optional license copyright being added if RAT is adding headers.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>org.apache.commons.io.filefilter.IOFileFilter</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#getDirectoryFilter--">getDirectoryFilter</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</a><<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#getFamilies--">getFamilies</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FilenameFilter.html?is-external=true" title="class or interface in java.io">FilenameFilter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#getInputFileFilter--">getInputFileFilter</a></span>()</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</a><<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#getLicenseFamilies-org.apache.rat.license.LicenseSetFactory.LicenseFilter-">getLicenseFamilies</a></span>(<a href="../../../org/apache/rat/license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a> filter)</code> |
| <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.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</a><<a href="../../../org/apache/rat/license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#getLicenses-org.apache.rat.license.LicenseSetFactory.LicenseFilter-">getLicenses</a></span>(<a href="../../../org/apache/rat/license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a> filter)</code> |
| <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.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>org.apache.commons.io.function.IOSupplier<<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#getOutput--">getOutput</a></span>()</code> |
| <div class="block">Returns the output stream supplier.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/rat/report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#getReportable--">getReportable</a></span>()</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>org.apache.commons.io.function.IOSupplier<<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#getStyleSheet--">getStyleSheet</a></span>()</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>org.apache.commons.io.function.IOSupplier<<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#getWriter--">getWriter</a></span>()</code> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses--">isAddingLicenses</a></span>()</code> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicensesForced--">isAddingLicensesForced</a></span>()</code> |
| <div class="block">This value is ignored if RAT is not adding licenses.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#isStyleReport--">isStyleReport</a></span>()</code> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#removeApprovedLicenseCategories-java.util.Collection-">removeApprovedLicenseCategories</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> familyCategory)</code> |
| <div class="block">Removes a license family category from the list of approved licenses.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#removeApprovedLicenseCategory-java.lang.String-">removeApprovedLicenseCategory</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> familyCategory)</code> |
| <div class="block">Adds a license family category to the list of approved licenses.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setAddLicenseHeaders-org.apache.rat.config.AddLicenseHeaders-">setAddLicenseHeaders</a></span>(<a href="../../../org/apache/rat/config/AddLicenseHeaders.html" title="enum in org.apache.rat.config">AddLicenseHeaders</a> addLicenseHeaders)</code> |
| <div class="block">Sets whether RAT should enable, disable, or force the adding of license |
| headers.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setCopyrightMessage-java.lang.String-">setCopyrightMessage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> copyrightMessage)</code> |
| <div class="block">Sets the optional copyright message used if RAT is adding license headers.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setDirectoryFilter-org.apache.commons.io.filefilter.IOFileFilter-">setDirectoryFilter</a></span>(org.apache.commons.io.filefilter.IOFileFilter directoryFilter)</code> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setFrom-org.apache.rat.Defaults-">setFrom</a></span>(<a href="../../../org/apache/rat/Defaults.html" title="class in org.apache.rat">Defaults</a> defaults)</code> |
| <div class="block">Adds the licenses and approved licenses from the defaults object to the |
| configuration.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setInputFileFilter-java.io.FilenameFilter-">setInputFileFilter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/FilenameFilter.html?is-external=true" title="class or interface in java.io">FilenameFilter</a> inputFileFilter)</code> </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setOut-java.io.File-">setOut</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code> |
| <div class="block">Sets the OutputStream supplier to use the specified file.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setOut-org.apache.commons.io.function.IOSupplier-">setOut</a></span>(org.apache.commons.io.function.IOSupplier<<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>> out)</code> |
| <div class="block">Sets the supplier for the output stream.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setReportable-org.apache.rat.report.IReportable-">setReportable</a></span>(<a href="../../../org/apache/rat/report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a> reportable)</code> </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setStyleReport-boolean-">setStyleReport</a></span>(boolean styleReport)</code> </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setStyleSheet-java.io.File-">setStyleSheet</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> styleSheet)</code> </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setStyleSheet-org.apache.commons.io.function.IOSupplier-">setStyleSheet</a></span>(org.apache.commons.io.function.IOSupplier<<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>> styleSheet)</code> |
| <div class="block">Sets the style sheet for custom processing.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setStyleSheet-java.net.URI-">setStyleSheet</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> styleSheet)</code> |
| <div class="block">Sets the style sheet for custom processing.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setStyleSheet-java.net.URL-">setStyleSheet</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> styleSheet)</code> |
| <div class="block">Sets the style sheet for custom processing.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#validate-java.util.function.Consumer-">validate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> logger)</code> |
| <div class="block">Validates that the configuration is valid.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ReportConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ReportConfiguration</h4> |
| <pre>public ReportConfiguration()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getInputFileFilter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputFileFilter</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FilenameFilter.html?is-external=true" title="class or interface in java.io">FilenameFilter</a> getInputFileFilter()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The filename filter for the potential input files.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInputFileFilter-java.io.FilenameFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInputFileFilter</h4> |
| <pre>public void setInputFileFilter(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/FilenameFilter.html?is-external=true" title="class or interface in java.io">FilenameFilter</a> inputFileFilter)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>inputFileFilter</code> - the filename filter to filter the input files.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDirectoryFilter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDirectoryFilter</h4> |
| <pre>public org.apache.commons.io.filefilter.IOFileFilter getDirectoryFilter()</pre> |
| </li> |
| </ul> |
| <a name="setDirectoryFilter-org.apache.commons.io.filefilter.IOFileFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDirectoryFilter</h4> |
| <pre>public void setDirectoryFilter(org.apache.commons.io.filefilter.IOFileFilter directoryFilter)</pre> |
| </li> |
| </ul> |
| <a name="addDirectoryFilter-org.apache.commons.io.filefilter.IOFileFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDirectoryFilter</h4> |
| <pre>public void addDirectoryFilter(org.apache.commons.io.filefilter.IOFileFilter directoryFilter)</pre> |
| </li> |
| </ul> |
| <a name="getReportable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReportable</h4> |
| <pre>public <a href="../../../org/apache/rat/report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a> getReportable()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the thing being reported on.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setReportable-org.apache.rat.report.IReportable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReportable</h4> |
| <pre>public void setReportable(<a href="../../../org/apache/rat/report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a> reportable)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reportable</code> - the thing being reported on.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStyleSheet--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStyleSheet</h4> |
| <pre>public org.apache.commons.io.function.IOSupplier<<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>> getStyleSheet()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Supplier of the InputStream that is the XSLT style sheet to style the report with.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStyleSheet-org.apache.commons.io.function.IOSupplier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStyleSheet</h4> |
| <pre>public void setStyleSheet(org.apache.commons.io.function.IOSupplier<<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>> styleSheet)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>styleSheet</code> - the XSLT style sheet to style the report with.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFrom-org.apache.rat.Defaults-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFrom</h4> |
| <pre>public void setFrom(<a href="../../../org/apache/rat/Defaults.html" title="class in org.apache.rat">Defaults</a> defaults)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>defaults</code> - The defaults to set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStyleSheet-java.io.File-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStyleSheet</h4> |
| <pre>public void setStyleSheet(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> styleSheet)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>styleSheet</code> - the XSLT style sheet to style the report with.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStyleSheet-java.net.URI-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStyleSheet</h4> |
| <pre>public void setStyleSheet(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> styleSheet)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>styleSheet</code> - the URI of the XSLT style sheet to style the report with.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStyleSheet-java.net.URL-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStyleSheet</h4> |
| <pre>public void setStyleSheet(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> styleSheet)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>styleSheet</code> - the URL of the XSLT style sheet to style the report with.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isStyleReport--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStyleReport</h4> |
| <pre>public boolean isStyleReport()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the XML report should be styled.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStyleReport-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStyleReport</h4> |
| <pre>public void setStyleReport(boolean styleReport)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>styleReport</code> - specifies whether the XML report should be styled.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOut-org.apache.commons.io.function.IOSupplier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOut</h4> |
| <pre>public void setOut(org.apache.commons.io.function.IOSupplier<<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>> out)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>out</code> - The OutputStream supplier that provides the output stream to write |
| the report to. (may be null)</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/apache/rat/ReportConfiguration.NoCloseOutputStream.html" title="class in org.apache.rat"><code>ReportConfiguration.NoCloseOutputStream</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOut-java.io.File-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOut</h4> |
| <pre>public void setOut(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</pre> |
| <div class="block">Sets the OutputStream supplier to use the specified file. The file may be |
| opened and closed several times. File is opened in append mode.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>file</code> - The file to create the supplier with.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/apache/rat/ReportConfiguration.html#setOut-org.apache.commons.io.function.IOSupplier-"><code>setOut(IOSupplier)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOutput--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutput</h4> |
| <pre>public org.apache.commons.io.function.IOSupplier<<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>> getOutput()</pre> |
| <div class="block">Returns the output stream supplier. If no stream has been set returns a |
| supplier for System.out.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The supplier of the output stream to write the report to.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWriter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriter</h4> |
| <pre>public org.apache.commons.io.function.IOSupplier<<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>> getWriter()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A supplier for a PrintWriter that wraps the output stream.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/apache/rat/ReportConfiguration.html#getOutput--"><code>getOutput()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addLicense-org.apache.rat.license.ILicense-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addLicense</h4> |
| <pre>public void addLicense(<a href="../../../org/apache/rat/license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a> license)</pre> |
| <div class="block">Adds a license to the list of licenses. Does not add the license to the list |
| of approved licenses.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>license</code> - The license to add to the list of licenses.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addLicense-org.apache.rat.license.ILicense.Builder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addLicense</h4> |
| <pre>public <a href="../../../org/apache/rat/license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a> addLicense(<a href="../../../org/apache/rat/license/ILicense.Builder.html" title="class in org.apache.rat.license">ILicense.Builder</a> builder)</pre> |
| <div class="block">Adds a license to the list of licenses. Does not add the license to the list |
| of approved licenses.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>builder</code> - The license builder to build and add to the list of licenses.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addLicenses-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addLicenses</h4> |
| <pre>public void addLicenses(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../org/apache/rat/license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a>> licenses)</pre> |
| <div class="block">Adds multiple licenses to the list of licenses. Does not add the licenses to |
| the list of approved licenses.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>licenses</code> - The licenses to add.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFamily-org.apache.rat.license.ILicenseFamily-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFamily</h4> |
| <pre>public void addFamily(<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a> family)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>family</code> - The license family to add to the list of license families.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFamily-org.apache.rat.license.ILicenseFamily.Builder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFamily</h4> |
| <pre>public void addFamily(<a href="../../../org/apache/rat/license/ILicenseFamily.Builder.html" title="interface in org.apache.rat.license">ILicenseFamily.Builder</a> builder)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>builder</code> - The licenseFamily.Builder to build and add to the list of |
| licenses.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFamilies-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFamilies</h4> |
| <pre>public void addFamilies(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>> families)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>families</code> - The license families to add.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFamilies--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFamilies</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</a><<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>> getFamilies()</pre> |
| </li> |
| </ul> |
| <a name="addApprovedLicenseCategory-org.apache.rat.license.ILicenseFamily-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addApprovedLicenseCategory</h4> |
| <pre>public void addApprovedLicenseCategory(<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a> approvedILicenseFamily)</pre> |
| <div class="block">Adds an ILicenseFamily to the list of approved licenses.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>approvedILicenseFamily</code> - the LicenseFamily to add.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addApprovedLicenseCategory-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addApprovedLicenseCategory</h4> |
| <pre>public void addApprovedLicenseCategory(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> familyCategory)</pre> |
| <div class="block">Adds a license family category (id) to the list of approved licenses</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>familyCategory</code> - the category to add.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addApprovedLicenseCategories-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addApprovedLicenseCategories</h4> |
| <pre>public void addApprovedLicenseCategories(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> approvedLicenseCategories)</pre> |
| <div class="block">Adds a collection of license family categories to the set of approved license |
| names.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>approvedLicenseCategories</code> - set of approved license categories.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeApprovedLicenseCategory-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeApprovedLicenseCategory</h4> |
| <pre>public void removeApprovedLicenseCategory(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> familyCategory)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>familyCategory</code> - the category to add.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeApprovedLicenseCategories-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeApprovedLicenseCategories</h4> |
| <pre>public void removeApprovedLicenseCategories(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> familyCategory)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>familyCategory</code> - the family category to remove.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getApprovedLicenseCategories--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getApprovedLicenseCategories</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getApprovedLicenseCategories()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Sorted set of approved license categories.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCopyrightMessage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCopyrightMessage</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCopyrightMessage()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the optional copyright message.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses--"><code>isAddingLicenses()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCopyrightMessage-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCopyrightMessage</h4> |
| <pre>public void setCopyrightMessage(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> copyrightMessage)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>copyrightMessage</code> - message to set.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses--"><code>isAddingLicenses()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAddingLicensesForced--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAddingLicensesForced</h4> |
| <pre>public boolean isAddingLicensesForced()</pre> |
| <div class="block">This value is ignored if RAT is not adding licenses.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if RAT is forcing the adding license headers.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses--"><code>isAddingLicenses()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAddingLicenses--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAddingLicenses</h4> |
| <pre>public boolean isAddingLicenses()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether RAT should add missing license headers.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicensesForced--"><code>isAddingLicensesForced()</code></a>, |
| <a href="../../../org/apache/rat/ReportConfiguration.html#getCopyrightMessage--"><code>getCopyrightMessage()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAddLicenseHeaders-org.apache.rat.config.AddLicenseHeaders-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAddLicenseHeaders</h4> |
| <pre>public void setAddLicenseHeaders(<a href="../../../org/apache/rat/config/AddLicenseHeaders.html" title="enum in org.apache.rat.config">AddLicenseHeaders</a> addLicenseHeaders)</pre> |
| <div class="block">Sets whether RAT should enable, disable, or force the adding of license |
| headers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>addLicenseHeaders</code> - enables/disables or forces adding of licenses |
| headers.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses--"><code>isAddingLicenses()</code></a>, |
| <a href="../../../org/apache/rat/ReportConfiguration.html#setCopyrightMessage-java.lang.String-"><code>setCopyrightMessage(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLicenses-org.apache.rat.license.LicenseSetFactory.LicenseFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLicenses</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</a><<a href="../../../org/apache/rat/license/ILicense.html" title="interface in org.apache.rat.license">ILicense</a>> getLicenses(<a href="../../../org/apache/rat/license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a> filter)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - The license filter.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The set of defined licenses.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLicenseFamilies-org.apache.rat.license.LicenseSetFactory.LicenseFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLicenseFamilies</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</a><<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>> getLicenseFamilies(<a href="../../../org/apache/rat/license/LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a> filter)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - The license filter.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The set of defined licenses.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate-java.util.function.Consumer-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>public void validate(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> logger)</pre> |
| <div class="block">Validates that the configuration is valid.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>logger</code> - String consumer to log warning messages to.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../org/apache/rat/Report.html" title="class in org.apache.rat"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/rat/ReportConfiguration.NoCloseOutputStream.html" title="class in org.apache.rat"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/rat/ReportConfiguration.html" target="_top">Frames</a></li> |
| <li><a href="ReportConfiguration.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <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> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2023 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
