| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (21) --> |
| <title>LicenseSetFactory (Apache Creadur RAT 0.17-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.rat.license, class: LicenseSetFactory"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/LicenseSetFactory.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li><a href="#nested-class-summary">Nested</a></li> |
| <li>Field</li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </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="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.rat.license</a></div> |
| <h1 title="Class LicenseSetFactory" class="title">Class LicenseSetFactory</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.license.LicenseSetFactory</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">LicenseSetFactory</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">Class to take a set of ILicenses and collection of approved license |
| categories and extract Subsets.</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 enum </code></div> |
| <div class="col-second even-row-color"><code><a href="LicenseSetFactory.LicenseFilter.html" class="type-name-link" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">An enum that defines the types of Licenses to extract.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">LicenseSetFactory</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs a factory with the specified set of Licenses and the approved |
| license collection.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.util.SortedSet)" class="member-name-link">LicenseSetFactory</a><wbr>(<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><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>> licenses)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Constructs a factory with the specified set of Licenses and the approved |
| license collection.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.apache.rat.license.LicenseSetFactory)" class="member-name-link">add</a><wbr>(<a href="LicenseSetFactory.html" title="class in org.apache.rat.license">LicenseSetFactory</a> other)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addFamily(org.apache.rat.license.ILicenseFamily)" class="member-name-link">addFamily</a><wbr>(<a href="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a> family)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a license family to the list of families.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addFamily(org.apache.rat.license.ILicenseFamily.Builder)" class="member-name-link">addFamily</a><wbr>(<a href="ILicenseFamily.Builder.html" title="class in org.apache.rat.license">ILicenseFamily.Builder</a> builder)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a license family to the list of families.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addLicense(org.apache.rat.license.ILicense)" class="member-name-link">addLicense</a><wbr>(<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a> license)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a license to the list of licenses.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addLicense(org.apache.rat.license.ILicense.Builder)" class="member-name-link">addLicense</a><wbr>(<a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a> builder)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a license to the list of licenses.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addLicenses(java.util.Collection)" class="member-name-link">addLicenses</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>> licenses)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds multiple licenses to the list of licenses.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#approveLicenseCategory(java.lang.String)" class="member-name-link">approveLicenseCategory</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> familyCategory)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a license family category (id) to the list of approved licenses</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#approveLicenseId(java.lang.String)" class="member-name-link">approveLicenseId</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> licenseId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a license family category (id) to the list of approved licenses</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#familyDuplicateOption(org.apache.rat.utils.ReportingSet.Options)" class="member-name-link">familyDuplicateOption</a><wbr>(<a href="../utils/ReportingSet.Options.html" title="enum in org.apache.rat.utils">ReportingSet.Options</a> state)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the reporting option for duplicate license families.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#familySearch(java.lang.String,java.util.SortedSet)" class="member-name-link">familySearch</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> target, |
| <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><<a href="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>> licenseFamilies)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Search a SortedSet of ILicenseFamily instances looking for a matching instance.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#familySearch(org.apache.rat.license.ILicenseFamily,java.util.SortedSet)" class="member-name-link">familySearch</a><wbr>(<a href="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a> target, |
| <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><<a href="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>> licenseFamilies)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Search a SortedSet of ILicenseFamily instances looking for a matching instance.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><wbr><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getApprovedLicensePredicate()" class="member-name-link">getApprovedLicensePredicate</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets a predicate to filter for approved licenses.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</a><wbr><<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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLicenseCategories(org.apache.rat.license.LicenseSetFactory.LicenseFilter)" class="member-name-link">getLicenseCategories</a><wbr>(<a href="LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a> filter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the License ids based on the filter.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</a><wbr><<a href="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLicenseFamilies(org.apache.rat.license.LicenseSetFactory.LicenseFilter)" class="member-name-link">getLicenseFamilies</a><wbr>(<a href="LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a> filter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the LicenseFamily objects based on the filter.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</a><wbr><<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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLicenseIds(org.apache.rat.license.LicenseSetFactory.LicenseFilter)" class="member-name-link">getLicenseIds</a><wbr>(<a href="LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a> filter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the License ids based on the filter.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</a><wbr><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLicenses(org.apache.rat.license.LicenseSetFactory.LicenseFilter)" class="member-name-link">getLicenses</a><wbr>(<a href="LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a> filter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the License objects based on the filter.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#licenseDuplicateOption(org.apache.rat.utils.ReportingSet.Options)" class="member-name-link">licenseDuplicateOption</a><wbr>(<a href="../utils/ReportingSet.Options.html" title="enum in org.apache.rat.utils">ReportingSet.Options</a> state)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the reporting option for duplicate licenses.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#logFamilyCollisions(org.apache.rat.utils.Log.Level)" class="member-name-link">logFamilyCollisions</a><wbr>(<a href="../utils/Log.Level.html" title="enum in org.apache.rat.utils">Log.Level</a> level)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the log level for reporting collisions in the set of license families.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#logLicenseCollisions(org.apache.rat.utils.Log.Level)" class="member-name-link">logLicenseCollisions</a><wbr>(<a href="../utils/Log.Level.html" title="enum in org.apache.rat.utils">Log.Level</a> level)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the log level for reporting license collisions.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeLicenseCategory(java.lang.String)" class="member-name-link">removeLicenseCategory</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> familyCategory)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a license family category (id) to the list of approved licenses</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeLicenseId(java.lang.String)" class="member-name-link">removeLicenseId</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> licenseId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes a license ID from the list of approved licenses.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#search(java.lang.String,java.lang.String,java.util.SortedSet)" class="member-name-link">search</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> familyId, |
| <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> licenseId, |
| <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><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>> licenses)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Search a SortedSet of licenses for the matching license id.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#search(org.apache.rat.license.ILicense,java.util.SortedSet)" class="member-name-link">search</a><wbr>(<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a> target, |
| <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><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>> licenses)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Search a SortedSet of licenses for the matching license.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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="<init>()"> |
| <h3>LicenseSetFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LicenseSetFactory</span>()</div> |
| <div class="block">Constructs a factory with the specified set of Licenses and the approved |
| license collection.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.util.SortedSet)"> |
| <h3>LicenseSetFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LicenseSetFactory</span><wbr><span class="parameters">(<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><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>> licenses)</span></div> |
| <div class="block">Constructs a factory with the specified set of Licenses and the approved |
| license collection.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>licenses</code> - the set of defined licenses. Families will be extracted from the licenses.</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="familySearch(java.lang.String,java.util.SortedSet)"> |
| <h3>familySearch</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a></span> <span class="element-name">familySearch</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> target, |
| <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><<a href="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>> licenseFamilies)</span></div> |
| <div class="block">Search a SortedSet of ILicenseFamily instances looking for a matching instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>target</code> - The instance to search for.</dd> |
| <dd><code>licenseFamilies</code> - the license families to search.</dd> |
| <dt>Returns:</dt> |
| <dd>the matching instance of the target given.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="familySearch(org.apache.rat.license.ILicenseFamily,java.util.SortedSet)"> |
| <h3>familySearch</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a></span> <span class="element-name">familySearch</span><wbr><span class="parameters">(<a href="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a> target, |
| <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><<a href="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>> licenseFamilies)</span></div> |
| <div class="block">Search a SortedSet of ILicenseFamily instances looking for a matching instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>target</code> - The instance to search for.</dd> |
| <dd><code>licenseFamilies</code> - the license families to search.</dd> |
| <dt>Returns:</dt> |
| <dd>the matching instance of the target given.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(org.apache.rat.license.LicenseSetFactory)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="LicenseSetFactory.html" title="class in org.apache.rat.license">LicenseSetFactory</a> other)</span></div> |
| </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> <span class="return-type">void</span> <span class="element-name">logFamilyCollisions</span><wbr><span class="parameters">(<a href="../utils/Log.Level.html" title="enum in org.apache.rat.utils">Log.Level</a> 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> <span class="return-type">void</span> <span class="element-name">familyDuplicateOption</span><wbr><span class="parameters">(<a href="../utils/ReportingSet.Options.html" title="enum in org.apache.rat.utils">ReportingSet.Options</a> 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> <span class="return-type">void</span> <span class="element-name">logLicenseCollisions</span><wbr><span class="parameters">(<a href="../utils/Log.Level.html" title="enum in org.apache.rat.utils">Log.Level</a> 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> <span class="return-type">void</span> <span class="element-name">licenseDuplicateOption</span><wbr><span class="parameters">(<a href="../utils/ReportingSet.Options.html" title="enum in org.apache.rat.utils">ReportingSet.Options</a> 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="addLicense(org.apache.rat.license.ILicense)"> |
| <h3>addLicense</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addLicense</span><wbr><span class="parameters">(<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a> 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> <span class="return-type"><a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a></span> <span class="element-name">addLicense</span><wbr><span class="parameters">(<a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a> builder)</span></div> |
| <div class="block">Adds a license to the list of licenses. Does not add the license to the list |
| of approved licenses.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>builder</code> - The license builder to build and add to the list of licenses.</dd> |
| <dt>Returns:</dt> |
| <dd>The ILicense implementation that was added.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addLicenses(java.util.Collection)"> |
| <h3>addLicenses</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addLicenses</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>> 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> <span class="return-type">void</span> <span class="element-name">addFamily</span><wbr><span class="parameters">(<a href="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a> 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> <span class="return-type">void</span> <span class="element-name">addFamily</span><wbr><span class="parameters">(<a href="ILicenseFamily.Builder.html" title="class in org.apache.rat.license">ILicenseFamily.Builder</a> 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="approveLicenseCategory(java.lang.String)"> |
| <h3>approveLicenseCategory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">approveLicenseCategory</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> 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="removeLicenseCategory(java.lang.String)"> |
| <h3>removeLicenseCategory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeLicenseCategory</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> 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="approveLicenseId(java.lang.String)"> |
| <h3>approveLicenseId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">approveLicenseId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> licenseId)</span></div> |
| <div class="block">Adds a license family category (id) to the list of approved licenses</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>licenseId</code> - the license ID to add.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeLicenseId(java.lang.String)"> |
| <h3>removeLicenseId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeLicenseId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> licenseId)</span></div> |
| <div class="block">Removes a license ID from the list of approved licenses.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>licenseId</code> - the license ID to remove.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getApprovedLicensePredicate()"> |
| <h3>getApprovedLicensePredicate</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>></span> <span class="element-name">getApprovedLicensePredicate</span>()</div> |
| <div class="block">Gets a predicate to filter for approved licenses.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a predicate that returns <code>true</code> if the license is approved.</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> <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><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>></span> <span class="element-name">getLicenses</span><wbr><span class="parameters">(<a href="LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a> filter)</span></div> |
| <div class="block">Gets the License objects based on the filter.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>filter</code> - the types of LicenseFamily objects to return.</dd> |
| <dt>Returns:</dt> |
| <dd>a SortedSet of ILicense objects.</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> <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><<a href="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>></span> <span class="element-name">getLicenseFamilies</span><wbr><span class="parameters">(<a href="LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a> filter)</span></div> |
| <div class="block">Gets the LicenseFamily objects based on the filter.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>filter</code> - the types of LicenseFamily objects to return.</dd> |
| <dt>Returns:</dt> |
| <dd>a SortedSet of ILicenseFamily objects.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLicenseCategories(org.apache.rat.license.LicenseSetFactory.LicenseFilter)"> |
| <h3>getLicenseCategories</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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><<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> <span class="element-name">getLicenseCategories</span><wbr><span class="parameters">(<a href="LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a> filter)</span></div> |
| <div class="block">Gets the License ids based on the filter.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>filter</code> - the types of License Ids to return.</dd> |
| <dt>Returns:</dt> |
| <dd>The list of all licenses in the category regardless of whether or not it is used by an ILicense implementation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLicenseIds(org.apache.rat.license.LicenseSetFactory.LicenseFilter)"> |
| <h3>getLicenseIds</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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><<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> <span class="element-name">getLicenseIds</span><wbr><span class="parameters">(<a href="LicenseSetFactory.LicenseFilter.html" title="enum in org.apache.rat.license">LicenseSetFactory.LicenseFilter</a> filter)</span></div> |
| <div class="block">Gets the License ids based on the filter.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>filter</code> - the types of License Ids to return.</dd> |
| <dt>Returns:</dt> |
| <dd>The list of all licenses in the category regardless of whether or not it is used by an ILicense implementation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="search(java.lang.String,java.lang.String,java.util.SortedSet)"> |
| <h3>search</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>></span> <span class="element-name">search</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> familyId, |
| <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> licenseId, |
| <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><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>> licenses)</span></div> |
| <div class="block">Search a SortedSet of licenses for the matching license id.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>licenseId</code> - the id to search for.</dd> |
| <dd><code>licenses</code> - the SortedSet of licenses to search.</dd> |
| <dt>Returns:</dt> |
| <dd>the matching license or <code>null</code> if not found.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="search(org.apache.rat.license.ILicense,java.util.SortedSet)"> |
| <h3>search</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>></span> <span class="element-name">search</span><wbr><span class="parameters">(<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a> target, |
| <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><<a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a>> licenses)</span></div> |
| <div class="block">Search a SortedSet of licenses for the matching license. |
| License must match both family code, and license id.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>target</code> - the license to search for. Must not be <code>null</code>.</dd> |
| <dd><code>licenses</code> - the SortedSet of licenses to search.</dd> |
| <dt>Returns:</dt> |
| <dd>the matching license or <code>null</code> if not found.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2006–2025 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
