ExecutableCommand (common 4.0.0-beta.17 API)

Type Parameters:

A - The actor type

All Superinterfaces:

java.lang.Comparable<ExecutableCommand<A>>, HasDescription, java.lang.Iterable<CommandNode<A>>, RequiresPermission<A>
```
public interface ExecutableCommand<A extends CommandActor>
extends java.lang.Comparable<ExecutableCommand<A>>, java.lang.Iterable<CommandNode<A>>, RequiresPermission<A>, HasDescription
```
Represents an immutable, full, separate command path that may be executed.

See Also:

test(CommandActor, MutableStringStream)

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default @NotNull CommandAction<A>`	`action()` Returns the action of this command.
`default @NotNull AnnotationList`	`annotations()` Returns the annotations on the function
`default Help.ChildrenCommands<A>`	`childrenCommands()` Returns all children commands of this command.
`Help.ChildrenCommands<A>`	`childrenCommands(A filterFor)` Returns all children commands of this command.
`@NotNull java.util.OptionalInt`	`commandPriority()` Returns the explicit priority defined by `CommandPriority`.
`boolean`	`containsFlags()` Tests whether the command has any `Flag` or `Switch` parameters
`@Nullable java.lang.String`	`description()` Returns the description of this command.
`default void`	`execute(A actor, @NotNull MutableStringStream input)` Executes this command with the given actor and input.
`void`	`execute(@NotNull ExecutionContext<A> context)` Executes this command with the given context.
`@NotNull LiteralNode<A>`	`firstNode()` Returns the first node in this command.
`@NotNull CommandFunction`	`function()` Returns the underlying `CommandFunction` of this command
`boolean`	`isChildOf(@NotNull ExecutableCommand<A> command)` Tests whether this command is a child of the provided command.
`default boolean`	`isParentOf(@NotNull ExecutableCommand<A> command)` Tests whether the provided command is a child of this command.
`default boolean`	`isRelatedTo(@NotNull ExecutableCommand<A> command)` Tests whether is the provided command related to this command or not.
`boolean`	`isSecret()` Tests whether this command is secret or not.
`boolean`	`isSiblingOf(@NotNull ExecutableCommand<A> command)` Tests whether are these two commands siblings.
`default boolean`	`isVisibleTo(A actor)` Tests whether this command is visible to the actor or not.
`@NotNull Lamp<A>`	`lamp()` Returns the `Lamp` instance that created this command
`@NotNull CommandNode<A>`	`lastNode()` Returns the very last node in this command.
`@NotNull @Unmodifiable java.util.List<CommandNode<A>>`	`nodes()` Returns an immutable `List` containing all the nodes in this command.
`int`	`optionalParameters()` Returns the number of optional parameters in this command
`default <T> @NotNull ParameterNode<A,T>`	`parameter(@NotNull java.lang.String name)` Returns the parameter with the given name, or throws `IllegalArgumentException` if it does not exist.
`default <T> @Nullable ParameterNode<A,T>`	`parameterOrNull(@NotNull java.lang.String name)` Returns the parameter with the given name, or `null` if it does not exist.
`@NotNull @Unmodifiable java.util.Map<java.lang.String,ParameterNode<A,java.lang.Object>>`	`parameters()` Returns all the parameters in this command, in the same order they are declared in the command.
`@NotNull java.lang.String`	`path()` Returns the path of this command.
`default @NotNull Help.RelatedCommands<A>`	`relatedCommands()` Returns all related commands of this command.
`@NotNull Help.RelatedCommands<A>`	`relatedCommands(A filterFor)` Returns all related commands of this command.
`int`	`requiredInput()` Returns the number of required literals or parameters in this command
`default Help.SiblingCommands<A>`	`siblingCommands()` Returns all siblings of this command
`Help.SiblingCommands<A>`	`siblingCommands(A filterFor)` Returns all siblings of this command
`@Range(from=1L,to=2147483647L) int`	`size()` Returns the amount of nodes in this command.
`@NotNull Potential<A>`	`test(A actor, @NotNull MutableStringStream input)` Tests this command with the given input, returning a `Potential` which contains the parameters parsed as well as any other errors that occurred during execution.
`void`	`unregister()` Unregisters this executable command.
`@NotNull java.lang.String`	`usage()` Returns the usage of this command.

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

Methods inherited from interface revxrsal.commands.node.RequiresPermission
permission

- Method Detail
  - lamp
```
@NotNull
@NotNull Lamp<A> lamp()
```
    Returns the Lamp instance that created this command
    
    Returns:
    
    The lamp instance
  - size
```
@Range(from=1L,to=2147483647L) int size()
```
    Returns the amount of nodes in this command. Larger nodes have higher priority over others.
    
    Returns:
    
    The command node
  - optionalParameters
```
int optionalParameters()
```
    Returns the number of optional parameters in this command
    
    Returns:
    
    The number of optional parameters
  - requiredInput
```
int requiredInput()
```
    Returns the number of required literals or parameters in this command
    
    Returns:
    
    The number of required literals or parameters
  - path
```
@NotNull
@NotNull java.lang.String path()
```
    Returns the path of this command. This will include parameters enclosed by brackets
    
    Returns:
    
    The path of the command.
  - usage
```
@NotNull
@NotNull java.lang.String usage()
```
    Returns the usage of this command. This can be explicitly set with @Usage. Otherwise, it will be auto-generated
    
    Returns:
    
    The command usage
  - description
```
@Nullable
@Nullable java.lang.String description()
```
    Returns the description of this command. This can be explicitly set with @Description.
    
    Specified by:
    
    description in interface HasDescription
    
    Returns:
    
    The description, or null if none is set.
  - function
```
@NotNull
@NotNull CommandFunction function()
```
    Returns the underlying CommandFunction of this command
    
    Returns:
    
    The underlying function
  - lastNode
```
@NotNull
@NotNull CommandNode<A> lastNode()
```
    Returns the very last node in this command.
    
    Returns:
    
    The last node
  - firstNode
```
@NotNull
@NotNull LiteralNode<A> firstNode()
```
    Returns the first node in this command. This will always be a LiteralNode
    
    Returns:
    
    The first node
  - test
```
@NotNull
 @CheckReturnValue
@NotNull Potential<A> test(@NotNull
                                                       A actor,
                                                       @NotNull
                                                       @NotNull MutableStringStream input)
```
    Tests this command with the given input, returning a Potential which contains the parameters parsed as well as any other errors that occurred during execution.
    
    Parameters:
    
    actor - The actor executing the command
    
    input - The input
    
    Returns:
    
    The Potential result
  - nodes
```
@NotNull
@NotNull @Unmodifiable java.util.List<CommandNode<A>> nodes()
```
    Returns an immutable List containing all the nodes in this command.
    
    Returns:
    
    All the nodes in the command
  - commandPriority
```
@NotNull
@NotNull java.util.OptionalInt commandPriority()
```
    Returns the explicit priority defined by CommandPriority.
    
    Returns:
    
    The command priority
  - isSecret
```
boolean isSecret()
```
    Tests whether this command is secret or not. Secret commands must be explicitly annotated using @SecretCommand.
    
    Returns:
    
    if this command is secret.
  - unregister
```
void unregister()
```
    Unregisters this executable command.
  - execute
```
default void execute(@NotNull
                     A actor,
                     @NotNull
                     @NotNull MutableStringStream input)
```
    Executes this command with the given actor and input.
    
    Parameters:
    
    actor - Actor to execute the command as
    
    input - The input to execute with
  - execute
```
void execute(@NotNull
             @NotNull ExecutionContext<A> context)
```
    Executes this command with the given context. It is the caller's responsibility to ensure that all required parameters are supplied in the context.
    Note that this will check all CommandCondition registered in the lamp() instance.
    
    Parameters:
    
    context - The context to execute with
  - action
```
@NotNull
default @NotNull CommandAction<A> action()
```
    Returns the action of this command.
    
    Returns:
    
    The command action
  - annotations
```
@NotNull
default @NotNull AnnotationList annotations()
```
    Returns the annotations on the function
    
    Returns:
    
    The function annotations
  - relatedCommands
```
@NotNull
@NotNull Help.RelatedCommands<A> relatedCommands(@Nullable
                                                          A filterFor)
```
    Returns all related commands of this command. This includes all sibling commands as well as children commands.
    
    Parameters:
    
    filterFor - Actor to filter entries for, by checking permissions
    
    Returns:
    
    The related commands
  - relatedCommands
```
@NotNull
default @NotNull Help.RelatedCommands<A> relatedCommands()
```
    Returns all related commands of this command. This includes all sibling commands as well as children commands.
    
    Returns:
    
    The related commands
  - childrenCommands
```
@NotNull
Help.ChildrenCommands<A> childrenCommands(@Nullable
                                                   A filterFor)
```
    Returns all children commands of this command.
    
    Parameters:
    
    filterFor - Actor to filter entries for, by checking permissions
    
    Returns:
    
    All children commands.
  - childrenCommands
```
@NotNull
default Help.ChildrenCommands<A> childrenCommands()
```
    Returns all children commands of this command.
    
    Returns:
    
    All children commands.
  - siblingCommands
```
@NotNull
Help.SiblingCommands<A> siblingCommands(@Nullable
                                                 A filterFor)
```
    Returns all siblings of this command
    
    Parameters:
    
    filterFor - Actor to filter entries for, by checking permissions
    
    Returns:
    
    All siblings
  - siblingCommands
```
@NotNull
default Help.SiblingCommands<A> siblingCommands()
```
    Returns all siblings of this command
    
    Returns:
    
    All siblings
  - parameters
```
@NotNull
 @Contract(pure=true)
@NotNull @Unmodifiable java.util.Map<java.lang.String,ParameterNode<A,java.lang.Object>> parameters()
```
    Returns all the parameters in this command, in the same order they are declared in the command.
    
    Returns:
    
    All the parameters
  - parameterOrNull
```
@Nullable
default <T> @Nullable ParameterNode<A,T> parameterOrNull(@NotNull
                                                                   @NotNull java.lang.String name)
```
    Returns the parameter with the given name, or null if it does not exist.
    
    Type Parameters:
    
    T - The parameter type, automatically cast.
    
    Parameters:
    
    name - The parameter name
    
    Returns:
    
    The parameter, or null if not present.
  - parameter
```
@NotNull
default <T> @NotNull ParameterNode<A,T> parameter(@NotNull
                                                           @NotNull java.lang.String name)
```
    Returns the parameter with the given name, or throws IllegalArgumentException if it does not exist.
    
    Type Parameters:
    
    T - The parameter type, automatically cast.
    
    Parameters:
    
    name - The parameter name
    
    Returns:
    
    The parameter
    
    Throws:
    
    java.lang.IllegalArgumentException - if it does not exist
  - isSiblingOf
```
boolean isSiblingOf(@NotNull
                    @NotNull ExecutableCommand<A> command)
```
    Tests whether are these two commands siblings.
    
    Parameters:
    
    command - Command to compare with
    
    Returns:
    
    true if they are siblings, false if otherwise.
  - isChildOf
```
boolean isChildOf(@NotNull
                  @NotNull ExecutableCommand<A> command)
```
    Tests whether this command is a child of the provided command.
    
    Parameters:
    
    command - Command to compare with
    
    Returns:
    
    true if it is a child, false if otherwise.
  - isParentOf
```
default boolean isParentOf(@NotNull
                           @NotNull ExecutableCommand<A> command)
```
    Tests whether the provided command is a child of this command.
    
    Parameters:
    
    command - Command to compare with
    
    Returns:
    
    true if it is a child, false if otherwise.
  - isRelatedTo
```
default boolean isRelatedTo(@NotNull
                            @NotNull ExecutableCommand<A> command)
```
    Tests whether is the provided command related to this command or not. This tests if it is a sibling or a child.
    
    Parameters:
    
    command - Command to test
    
    Returns:
    
    true if related, false if otherwise.
  - isVisibleTo
```
default boolean isVisibleTo(@NotNull
                            A actor)
```
    Tests whether this command is visible to the actor or not.
    This involves checking if the command for:
    1. Secrecy (SecretCommand): As these cannot be seen by any command
    2. Permission: If the actor has permission to use the command
    Parameters:
    
    actor - Actor to show the message to
    
    Returns:
    
    if th
  - containsFlags
```
boolean containsFlags()
```
    Tests whether the command has any Flag or Switch parameters
    
    Returns:
    
    if the command contains Flag or Switch

Interface ExecutableCommand<A extends CommandActor>

Method Summary

Methods inherited from interface java.lang.Comparable

Methods inherited from interface java.lang.Iterable

Methods inherited from interface revxrsal.commands.node.RequiresPermission

Method Detail

lamp

size

optionalParameters

requiredInput

path

usage

description

function

lastNode

firstNode

test

nodes

commandPriority

isSecret

unregister

execute

execute

action

annotations

relatedCommands

relatedCommands

childrenCommands

childrenCommands

siblingCommands

siblingCommands

parameters

parameterOrNull

parameter

isSiblingOf

isChildOf

isParentOf

isRelatedTo

isVisibleTo

containsFlags