Plan/all/com/djrapitops/plan/commands/use/CommandWithSubcommands.Builder.html

385 lines
19 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>CommandWithSubcommands.Builder (Plan 5.2-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandWithSubcommands.Builder (Plan 5.2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.commands.use</a></div>
<h2 title="Class CommandWithSubcommands.Builder" class="title">Class CommandWithSubcommands.Builder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="Subcommand.Builder.html" title="class in com.djrapitops.plan.commands.use">com.djrapitops.plan.commands.use.Subcommand.Builder</a>&lt;<a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a>&gt;</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.commands.use.CommandWithSubcommands.Builder</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="SubcommandBuilder.html" title="interface in com.djrapitops.plan.commands.use">SubcommandBuilder</a></code></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="CommandWithSubcommands.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands</a></dd>
</dl>
<hr>
<pre>public static class <span class="typeNameLabel">CommandWithSubcommands.Builder</span>
extends <a href="Subcommand.Builder.html" title="class in com.djrapitops.plan.commands.use">Subcommand.Builder</a>&lt;<a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a>&gt;</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="CommandWithSubcommands.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build()">build</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#colorScheme(com.djrapitops.plan.commands.use.ColorScheme)">colorScheme</a></span>&#8203;(<a href="ColorScheme.html" title="class in com.djrapitops.plan.commands.use">ColorScheme</a>&nbsp;colors)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#exceptionHandler(com.djrapitops.plan.utilities.java.TriConsumer)">exceptionHandler</a></span>&#8203;(<a href="../../utilities/java/TriConsumer.html" title="interface in com.djrapitops.plan.utilities.java">TriConsumer</a>&lt;java.lang.RuntimeException,&#8203;<a href="CMDSender.html" title="interface in com.djrapitops.plan.commands.use">CMDSender</a>,&#8203;<a href="Arguments.html" title="class in com.djrapitops.plan.commands.use">Arguments</a>&gt;&nbsp;exceptionHandler)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fallback(java.util.function.BiConsumer)">fallback</a></span>&#8203;(java.util.function.BiConsumer&lt;<a href="CMDSender.html" title="interface in com.djrapitops.plan.commands.use">CMDSender</a>,&#8203;<a href="Arguments.html" title="class in com.djrapitops.plan.commands.use">Arguments</a>&gt;&nbsp;executor)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fallbackOrHelpFallback(java.util.function.BiPredicate,java.util.function.BiConsumer)">fallbackOrHelpFallback</a></span>&#8203;(java.util.function.BiPredicate&lt;<a href="CMDSender.html" title="interface in com.djrapitops.plan.commands.use">CMDSender</a>,&#8203;<a href="Arguments.html" title="class in com.djrapitops.plan.commands.use">Arguments</a>&gt;&nbsp;canBeUsed,
java.util.function.BiConsumer&lt;<a href="CMDSender.html" title="interface in com.djrapitops.plan.commands.use">CMDSender</a>,&#8203;<a href="Arguments.html" title="class in com.djrapitops.plan.commands.use">Arguments</a>&gt;&nbsp;executor)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subcommand(com.djrapitops.plan.commands.use.Subcommand)">subcommand</a></span>&#8203;(<a href="Subcommand.html" title="class in com.djrapitops.plan.commands.use">Subcommand</a>&nbsp;subcommand)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subcommandOnCondition(boolean,com.djrapitops.plan.commands.use.Subcommand)">subcommandOnCondition</a></span>&#8203;(boolean&nbsp;condition,
<a href="Subcommand.html" title="class in com.djrapitops.plan.commands.use">Subcommand</a>&nbsp;subcommand)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.djrapitops.plan.commands.use.Subcommand.Builder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.djrapitops.plan.commands.use.<a href="Subcommand.Builder.html" title="class in com.djrapitops.plan.commands.use">Subcommand.Builder</a></h3>
<code><a href="Subcommand.Builder.html#alias(java.lang.String)">alias</a>, <a href="Subcommand.Builder.html#aliases(java.lang.String...)">aliases</a>, <a href="Subcommand.Builder.html#description(java.lang.String)">description</a>, <a href="Subcommand.Builder.html#inDepthDescription(java.lang.String...)">inDepthDescription</a>, <a href="Subcommand.Builder.html#onCommand(java.util.function.BiConsumer)">onCommand</a>, <a href="Subcommand.Builder.html#onTabComplete(java.util.function.BiFunction)">onTabComplete</a>, <a href="Subcommand.Builder.html#optionalArgument(java.lang.String,java.lang.String)">optionalArgument</a>, <a href="Subcommand.Builder.html#requiredArgument(java.lang.String,java.lang.String)">requiredArgument</a>, <a href="Subcommand.Builder.html#requirePermission(java.lang.String)">requirePermission</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.djrapitops.plan.commands.use.SubcommandBuilder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.djrapitops.plan.commands.use.<a href="SubcommandBuilder.html" title="interface in com.djrapitops.plan.commands.use">SubcommandBuilder</a></h3>
<code><a href="SubcommandBuilder.html#inDepthDescription(java.lang.String)">inDepthDescription</a>, <a href="SubcommandBuilder.html#onCommand(java.util.function.Consumer)">onCommand</a>, <a href="SubcommandBuilder.html#requirePermission(com.djrapitops.plan.settings.Permissions)">requirePermission</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="subcommand(com.djrapitops.plan.commands.use.Subcommand)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subcommand</h4>
<pre class="methodSignature">public&nbsp;<a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a>&nbsp;subcommand&#8203;(<a href="Subcommand.html" title="class in com.djrapitops.plan.commands.use">Subcommand</a>&nbsp;subcommand)</pre>
</li>
</ul>
<a id="subcommandOnCondition(boolean,com.djrapitops.plan.commands.use.Subcommand)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subcommandOnCondition</h4>
<pre class="methodSignature">public&nbsp;<a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a>&nbsp;subcommandOnCondition&#8203;(boolean&nbsp;condition,
<a href="Subcommand.html" title="class in com.djrapitops.plan.commands.use">Subcommand</a>&nbsp;subcommand)</pre>
</li>
</ul>
<a id="fallback(java.util.function.BiConsumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fallback</h4>
<pre class="methodSignature">public&nbsp;<a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a>&nbsp;fallback&#8203;(java.util.function.BiConsumer&lt;<a href="CMDSender.html" title="interface in com.djrapitops.plan.commands.use">CMDSender</a>,&#8203;<a href="Arguments.html" title="class in com.djrapitops.plan.commands.use">Arguments</a>&gt;&nbsp;executor)</pre>
</li>
</ul>
<a id="fallbackOrHelpFallback(java.util.function.BiPredicate,java.util.function.BiConsumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fallbackOrHelpFallback</h4>
<pre class="methodSignature">public&nbsp;<a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a>&nbsp;fallbackOrHelpFallback&#8203;(java.util.function.BiPredicate&lt;<a href="CMDSender.html" title="interface in com.djrapitops.plan.commands.use">CMDSender</a>,&#8203;<a href="Arguments.html" title="class in com.djrapitops.plan.commands.use">Arguments</a>&gt;&nbsp;canBeUsed,
java.util.function.BiConsumer&lt;<a href="CMDSender.html" title="interface in com.djrapitops.plan.commands.use">CMDSender</a>,&#8203;<a href="Arguments.html" title="class in com.djrapitops.plan.commands.use">Arguments</a>&gt;&nbsp;executor)</pre>
</li>
</ul>
<a id="exceptionHandler(com.djrapitops.plan.utilities.java.TriConsumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exceptionHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a>&nbsp;exceptionHandler&#8203;(<a href="../../utilities/java/TriConsumer.html" title="interface in com.djrapitops.plan.utilities.java">TriConsumer</a>&lt;java.lang.RuntimeException,&#8203;<a href="CMDSender.html" title="interface in com.djrapitops.plan.commands.use">CMDSender</a>,&#8203;<a href="Arguments.html" title="class in com.djrapitops.plan.commands.use">Arguments</a>&gt;&nbsp;exceptionHandler)</pre>
</li>
</ul>
<a id="colorScheme(com.djrapitops.plan.commands.use.ColorScheme)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>colorScheme</h4>
<pre class="methodSignature">public&nbsp;<a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a>&nbsp;colorScheme&#8203;(<a href="ColorScheme.html" title="class in com.djrapitops.plan.commands.use">ColorScheme</a>&nbsp;colors)</pre>
</li>
</ul>
<a id="build()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre class="methodSignature">public&nbsp;<a href="CommandWithSubcommands.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands</a>&nbsp;build()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SubcommandBuilder.html#build()">build</a></code>&nbsp;in interface&nbsp;<code><a href="SubcommandBuilder.html" title="interface in com.djrapitops.plan.commands.use">SubcommandBuilder</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="Subcommand.Builder.html#build()">build</a></code>&nbsp;in class&nbsp;<code><a href="Subcommand.Builder.html" title="class in com.djrapitops.plan.commands.use">Subcommand.Builder</a>&lt;<a href="CommandWithSubcommands.Builder.html" title="class in com.djrapitops.plan.commands.use">CommandWithSubcommands.Builder</a>&gt;</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>