Interface CommandSyntaxFormatter<C>

    • Method Detail

      • apply

        @NonNull String apply​(@NonNull List<@NonNull CommandArgument<C,​?>> commandArguments,
                              @Nullable CommandTree.Node<@Nullable CommandArgument<C,​?>> node)
        Format the command arguments into a syntax string
        Parameters:
        commandArguments - Command arguments that have been unambiguously specified up until this point. This should include the "current" command, if such a command exists.
        node - The current command node. The children of this node will be appended onto the command syntax string, as long as an unambiguous path can be identified. The node itself will not be appended onto the syntax string. This can be set to null if no node is relevant at the point of formatting.
        Returns:
        The formatted syntax string