Package cloud.commandframework.arguments

Interface CommandSyntaxFormatter<C>

  • Type Parameters:
    C - Command sender type
    All Known Implementing Classes:
    StandardCommandSyntaxFormatter
    Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    @FunctionalInterface
public interface CommandSyntaxFormatter<C>
    Utility that formats chains of command arguments into syntax strings

    • Method Summary

      Modifier and Type Method Description
      @NonNull java.lang.String apply​(@NonNull java.util.List<@NonNull CommandArgument<C,​?>> commandArguments, @Nullable CommandTree.Node<@Nullable CommandArgument<C,​?>> node)
      Format the command arguments into a syntax string

    • Method Detail

      • apply

        @NonNull java.lang.String apply​(@NonNull java.util.List<@NonNull CommandArgument<C,​?>> commandArguments,
                                @Nullable CommandTree.Node<@Nullable CommandArgument<C,​?>> node)
        Format the command arguments into a syntax string
        Parameters:
        commandArguments - Command arguments
        node - Trailing node
        Returns:
        Syntax string