public class CommandInfo
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static Builder<CommandInfo> |
COMMAND_INFO_BUILDER |
Constructor and Description |
---|
CommandInfo(long arity,
java.util.List<java.lang.String> flags,
long firstKey,
long lastKey,
long step,
java.util.List<java.lang.String> aclCategories,
java.util.List<java.lang.String> tips,
java.util.List<java.lang.String> subcommands) |
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.String> |
getAclCategories()
An array of simple strings that are the ACL categories to which the command belongs
|
long |
getArity()
Arity is the number of arguments a command expects.
|
long |
getFirstKey()
The position of the command's first key name argument
|
java.util.List<java.lang.String> |
getFlags()
Command flags
|
long |
getLastKey()
The position of the command's last key name argument
Commands that accept a single key have both first key and last key set to 1
|
long |
getStep()
This value is the step, or increment, between the first key and last key values where the keys are
|
java.util.List<java.lang.String> |
getSubcommands()
All the command's subcommands, if any
|
java.util.List<java.lang.String> |
getTips()
Helpful information about the command
|
public static final Builder<CommandInfo> COMMAND_INFO_BUILDER
public CommandInfo(long arity, java.util.List<java.lang.String> flags, long firstKey, long lastKey, long step, java.util.List<java.lang.String> aclCategories, java.util.List<java.lang.String> tips, java.util.List<java.lang.String> subcommands)
public long getArity()
public java.util.List<java.lang.String> getFlags()
public long getFirstKey()
public long getLastKey()
public long getStep()
public java.util.List<java.lang.String> getAclCategories()
public java.util.List<java.lang.String> getTips()
public java.util.List<java.lang.String> getSubcommands()
Copyright © 2023. All rights reserved.