<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) -->
<title>CommandParameters (server 1.5-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: dev.plex.command.annotation, annotation type: CommandParameters">
<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.6.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="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>Field</li>
<li><a href="#annotation-interface-required-element-summary">Required</a></li>
<li><a href="#annotation-interface-optional-element-summary">Optional</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li><a href="#annotation-interface-element-detail">Element</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary: </li>
<li>Field | </li>
<li><a href="#annotation-interface-required-element-summary">Required</a> | </li>
<li><a href="#annotation-interface-optional-element-summary">Optional</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#annotation-interface-element-detail">Element</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">dev.plex.command.annotation</a></div>
<h1 title="Annotation Interface CommandParameters" class="title">Annotation Interface
CommandParameters</h1>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="annotations"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/annotation/Retention.html"
title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME"
title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
</span><span class="modifiers">public @interface </span><span
class="element-name type-name-label">CommandParameters</span></div>
<div class="block">Storage for a command's parameters</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== ANNOTATION INTERFACE REQUIRED MEMBER SUMMARY =========== -->
<li>
<section class="member-summary" id="annotation-interface-required-element-summary">
<h2>Required Element Summary</h2>
<div class="caption"><span>Required Elements</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">Required Element</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/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"><code><a href="#name()" class="member-name-link">name</a></code>
</div>
<div class="col-last even-row-color">
<div class="block">The name</div>
</div>
</div>
</section>
</li>
<!-- =========== ANNOTATION INTERFACE OPTIONAL MEMBER SUMMARY =========== -->
<li>
<section class="member-summary" id="annotation-interface-optional-element-summary">
<h2>Optional Element Summary</h2>
<div class="caption"><span>Optional Elements</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">Optional Element</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/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"><code><a href="#aliases()"
class="member-name-link">aliases</a></code>
</div>
<div class="col-last even-row-color">
<div class="block">The aliases (optional)</div>
</div>
<div class="col-first odd-row-color"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang" class="external-link">String</a></code>
</div>
<div class="col-second odd-row-color"><code><a href="#description()"
class="member-name-link">description</a></code>
</div>
<div class="col-last odd-row-color">
<div class="block">The description</div>
</div>
<div class="col-first even-row-color"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/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"><code><a href="#usage()"
class="member-name-link">usage</a></code>
</div>
<div class="col-last even-row-color">
<div class="block">The usage (optional)</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details" id="annotation-interface-element-detail">
<ul class="details-list">
<!-- ============ ANNOTATION INTERFACE MEMBER DETAIL =========== -->
<li>
<section class="member-details">
<h2>Element Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="name()">
<h3>name</h3>
<div class="member-signature"><span class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang" class="external-link">String</a></span> <span
class="element-name">name</span></div>
<div class="block">The name</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Name of the command</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="description()">
<h3>description</h3>
<div class="member-signature"><span class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang" class="external-link">String</a></span> <span
class="element-name">description</span></div>
<div class="block">The description</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Description of the command</dd>
</dl>
<dl class="notes">
<dt>Default:</dt>
<dd><code>""</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="usage()">
<h3>usage</h3>
<div class="member-signature"><span class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang" class="external-link">String</a></span> <span
class="element-name">usage</span></div>
<div class="block">The usage (optional)</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The usage of the command</dd>
</dl>
<dl class="notes">
<dt>Default:</dt>
<dd><code>"/<command>"</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="aliases()">
<h3>aliases</h3>
<div class="member-signature"><span class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang" class="external-link">String</a></span> <span
class="element-name">aliases</span></div>
<div class="block">The aliases (optional)</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The aliases of the command</dd>
</dl>
<dl class="notes">
<dt>Default:</dt>
<dd><code>""</code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>