| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (21) --> |
| <title>ILicense.Builder (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, interface: ILicense, interface: Builder"> |
| <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/ILicense.Builder.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>Nested</li> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li>Constr</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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface ILicense.Builder" class="title">Interface ILicense.Builder</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../analysis/IHeaderMatcher.Builder.html" title="interface in org.apache.rat.analysis">IHeaderMatcher.Builder</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="SimpleLicense.Builder.html" title="class in org.apache.rat.license">SimpleLicense.Builder</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing interface:</dt> |
| <dd><code><a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">ILicense.Builder</span><span class="extends-implements"> |
| extends <a href="../analysis/IHeaderMatcher.Builder.html" title="interface in org.apache.rat.analysis">IHeaderMatcher.Builder</a></span></div> |
| <div class="block">A builder for ILicense instances.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><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-tab3"><code><a href="#build()" class="member-name-link">build</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Builds the license.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setFamily(java.lang.String)" class="member-name-link">setFamily</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> licenseFamilyCategory)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Set the family category for this license.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setId(java.lang.String)" class="member-name-link">setId</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> id)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the ID of the license.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLicenseFamilies(java.util.SortedSet)" class="member-name-link">setLicenseFamilies</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="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-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the set of license families to use during build.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setMatcher(org.apache.rat.analysis.IHeaderMatcher)" class="member-name-link">setMatcher</a><wbr>(<a href="../analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a> matcher)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the matcher.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setMatcher(org.apache.rat.analysis.IHeaderMatcher.Builder)" class="member-name-link">setMatcher</a><wbr>(<a href="../analysis/IHeaderMatcher.Builder.html" title="interface in org.apache.rat.analysis">IHeaderMatcher.Builder</a> matcher)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the matcher from a builder.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setName(java.lang.String)" class="member-name-link">setName</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> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the name of the license.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setNote(java.lang.String)" class="member-name-link">setNote</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> notes)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the notes for the license.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.rat.analysis.IHeaderMatcher.Builder">Methods inherited from interface org.apache.rat.analysis.<a href="../analysis/IHeaderMatcher.Builder.html" title="interface in org.apache.rat.analysis">IHeaderMatcher.Builder</a></h3> |
| <code><a href="../analysis/IHeaderMatcher.Builder.html#getDescription()">getDescription</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setMatcher(org.apache.rat.analysis.IHeaderMatcher.Builder)"> |
| <h3>setMatcher</h3> |
| <div class="member-signature"><span class="return-type"><a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a></span> <span class="element-name">setMatcher</span><wbr><span class="parameters">(<a href="../analysis/IHeaderMatcher.Builder.html" title="interface in org.apache.rat.analysis">IHeaderMatcher.Builder</a> matcher)</span></div> |
| <div class="block">Sets the matcher from a builder.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>matcher</code> - the builder for the matcher for the license.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder for chaining.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMatcher(org.apache.rat.analysis.IHeaderMatcher)"> |
| <h3>setMatcher</h3> |
| <div class="member-signature"><span class="return-type"><a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a></span> <span class="element-name">setMatcher</span><wbr><span class="parameters">(<a href="../analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a> matcher)</span></div> |
| <div class="block">Sets the matcher.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>matcher</code> - the matcher for the license.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder for chaining.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setNote(java.lang.String)"> |
| <h3>setNote</h3> |
| <div class="member-signature"><span class="return-type"><a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a></span> <span class="element-name">setNote</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> notes)</span></div> |
| <div class="block">Sets the notes for the license. If called multiple times the notes are |
| concatenated to create a single note.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>notes</code> - the notes for the license.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder for chaining.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setId(java.lang.String)"> |
| <h3>setId</h3> |
| <div class="member-signature"><span class="return-type"><a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a></span> <span class="element-name">setId</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> id)</span></div> |
| <div class="block">Sets the ID of the license. If the ID is not set then the ID of the license |
| family is used.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - the ID for the license</dd> |
| <dt>Returns:</dt> |
| <dd>this builder for chaining.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFamily(java.lang.String)"> |
| <h3>setFamily</h3> |
| <div class="member-signature"><span class="return-type"><a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a></span> <span class="element-name">setFamily</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> licenseFamilyCategory)</span></div> |
| <div class="block">Set the family category for this license. The category must be unique across |
| all licenses and must be 5 characters. If more than 5 characters are provided |
| then only the first 5 are taken. If fewer than 5 characters are provided the |
| category is padded with spaces.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>licenseFamilyCategory</code> - the family category for the license.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder for chaining.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setName(java.lang.String)"> |
| <h3>setName</h3> |
| <div class="member-signature"><span class="return-type"><a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a></span> <span class="element-name">setName</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> name)</span></div> |
| <div class="block">Sets the name of the license. If the name is not set then the name of the |
| license family is used.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name for the license</dd> |
| <dt>Returns:</dt> |
| <dd>this builder for chaining.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLicenseFamilies(java.util.SortedSet)"> |
| <h3>setLicenseFamilies</h3> |
| <div class="member-signature"><span class="return-type"><a href="ILicense.Builder.html" title="interface in org.apache.rat.license">ILicense.Builder</a></span> <span class="element-name">setLicenseFamilies</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="ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>> licenseFamilies)</span></div> |
| <div class="block">Sets the set of license families to use during build.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>licenseFamilies</code> - the license families to use</dd> |
| <dt>Returns:</dt> |
| <dd>this builder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="build()"> |
| <h3>build</h3> |
| <div class="member-signature"><span class="return-type"><a href="ILicense.html" title="interface in org.apache.rat.license">ILicense</a></span> <span class="element-name">build</span>()</div> |
| <div class="block">Builds the license.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../analysis/IHeaderMatcher.Builder.html#build()">build</a></code> in interface <code><a href="../analysis/IHeaderMatcher.Builder.html" title="interface in org.apache.rat.analysis">IHeaderMatcher.Builder</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>A new License implementation.</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> |
