<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (16) --> <title>CompositeResolver.Builder (api 5.4-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: com.djrapitops.plan.delivery.web.resolver, class: CompositeResolver, class: 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"> <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> <script type="text/javascript" src="../../../../../../script.js"></script> <script type="text/javascript" src="../../../../../../script-dir/jquery-3.5.1.min.js"></script> <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> </head> <body class="class-declaration-page"> <script type="text/javascript">var evenRowColor = "even-row-color"; var oddRowColor = "odd-row-color"; var tableTab = "table-tab"; var activeTableTab = "active-table-tab"; var pathtoroot = "../../../../../../"; loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <div class="flex-box"> <header role="banner" class="flex-header"> <nav role="navigation"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="top-nav" id="navbar.top"> <div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <ul id="navbar.top.firstrow" class="nav-list" title="Navigation"> <li><a href="../../../../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="nav-bar-cell1-rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../../../index-all.html">Index</a></li> <li><a href="../../../../../../help-doc.html">Help</a></li> </ul> </div> <div class="sub-nav"> <div> <ul class="sub-nav-list"> <li>Summary: </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"><label for="search">SEARCH:</label> <input type="text" id="search" value="search" disabled="disabled"> <input type="reset" id="reset" value="reset" disabled="disabled"> </div> </div> <!-- ========= END OF TOP NAVBAR ========= --> <span class="skip-nav" id="skip.navbar.top"> <!-- --> </span></nav> </header> <div class="flex-content"> <main role="main"> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.djrapitops.plan.delivery.web.resolver</a></div> <h1 title="Class CompositeResolver.Builder" class="title">Class CompositeResolver.Builder</h1> </div> <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> <div class="inheritance">com.djrapitops.plan.delivery.web.resolver.CompositeResolver.Builder</div> </div> <section class="description"> <dl class="notes"> <dt>Enclosing class:</dt> <dd><a href="CompositeResolver.html" title="class in com.djrapitops.plan.delivery.web.resolver">CompositeResolver</a></dd> </dl> <hr> <div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">CompositeResolver.Builder</span> <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> <div id="method-summary-table.tabpanel" role="tabpanel"> <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> <div class="table-header col-first">Modifier and Type</div> <div class="table-header col-second">Method</div> <div class="table-header col-last">Description</div> <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CompositeResolver.Builder.html" title="class in com.djrapitops.plan.delivery.web.resolver">CompositeResolver.Builder</a></code></div> <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#add(java.lang.String,com.djrapitops.plan.delivery.web.resolver.Resolver)">add</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> prefix, <a href="Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a> resolver)</code></div> <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> <div class="block">Add a new resolver to the CompositeResolver.</div> </div> <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CompositeResolver.Builder.html" title="class in com.djrapitops.plan.delivery.web.resolver">CompositeResolver.Builder</a></code></div> <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#add(java.lang.String,java.util.function.Function,java.util.function.Predicate)">add</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> prefix, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>,​<a href="Response.html" title="class in com.djrapitops.plan.delivery.web.resolver">Response</a>> resolver, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>> accessCheck)</code></div> <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> <div class="block">Add a new resolver to the CompositeResolver by using functional interfaces</div> </div> <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CompositeResolver.html" title="class in com.djrapitops.plan.delivery.web.resolver">CompositeResolver</a></code></div> <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#build()">build</a></span>()</code></div> <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </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/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/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/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/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"> <!-- ============ METHOD DETAIL ========== --> <li> <section class="method-details" id="method.detail"> <h2>Method Details</h2> <ul class="member-list"> <li> <section class="detail" id="add(java.lang.String,com.djrapitops.plan.delivery.web.resolver.Resolver)"> <h3>add</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompositeResolver.Builder.html" title="class in com.djrapitops.plan.delivery.web.resolver">CompositeResolver.Builder</a></span> <span class="element-name">add</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> prefix, <a href="Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a> resolver)</span></div> <div class="block">Add a new resolver to the CompositeResolver.</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>prefix</code> - Start of the target (first part of the target string, eg "example" in "/example/target/", or "" in "/")</dd> <dd><code>resolver</code> - Resolver to call for this target, <a href="request/URIPath.html#omitFirst()"><code>URIPath.omitFirst()</code></a> will be called for Resolver method calls.</dd> <dt>Returns:</dt> <dd>this builder.</dd> </dl> </section> </li> <li> <section class="detail" id="add(java.lang.String,java.util.function.Function,java.util.function.Predicate)"> <h3>add</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CompositeResolver.Builder.html" title="class in com.djrapitops.plan.delivery.web.resolver">CompositeResolver.Builder</a></span> <span class="element-name">add</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> prefix, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>,​<a href="Response.html" title="class in com.djrapitops.plan.delivery.web.resolver">Response</a>> resolver, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>> accessCheck)</span></div> <div class="block">Add a new resolver to the CompositeResolver by using functional interfaces</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>prefix</code> - Start of the target (first part of the target string, eg "example" in "/example/target/", or "" in "/")</dd> <dd><code>resolver</code> - Resolver to call for this target, <a href="request/URIPath.html#omitFirst()"><code>URIPath.omitFirst()</code></a> will be called for Resolver method calls.</dd> <dd><code>accessCheck</code> - Function for checking if request should be allowed (true, default) or forbidden (false).</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="modifiers">public</span> <span class="return-type"><a href="CompositeResolver.html" title="class in com.djrapitops.plan.delivery.web.resolver">CompositeResolver</a></span> <span class="element-name">build</span>()</div> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>