public abstract class CommandArgument extends java.lang.Object implements ArgAcceptingCommandPart
| Modifier and Type | Class and Description |
|---|---|
static class |
CommandArgument.Builder |
| Constructor and Description |
|---|
CommandArgument() |
| Modifier and Type | Method and Description |
|---|---|
static CommandArgument.Builder |
builder(net.kyori.text.TranslatableComponent name,
net.kyori.text.Component description) |
net.kyori.text.Component |
getTextRepresentation()
Returns the text representation of this part.
|
boolean |
isRequired()
Returns
true if this part is required, and may not be
missing from the command line. |
abstract boolean |
isVariable()
Check if this argument a variable argument.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetDefaults, getTypes, valuegetArgumentNamegetDescription, inpublic static CommandArgument.Builder builder(net.kyori.text.TranslatableComponent name, net.kyori.text.Component description)
public abstract boolean isVariable()
public final boolean isRequired()
true if this part is required, and may not be
missing from the command line.
Arguments are always required when they have no defaults.
To provide a null default, use the empty string.
isRequired in interface CommandPartpublic net.kyori.text.Component getTextRepresentation()
CommandPartFor flags, this could be something like `-flag`. For arguments and commands, this could be their name.
getTextRepresentation in interface CommandPart