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.
Utility that formats chains of
command arguments
into syntax strings-
Method Summary
Modifier and TypeMethodDescription@NonNull String
apply(@NonNull List<@NonNull CommandArgument<C,?>> commandArguments, @Nullable CommandTree.Node<@Nullable CommandArgument<C,?>> node)
Format the command arguments into a syntax string
-
Method Details
-
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 tonull
if no node is relevant at the point of formatting.- Returns:
- The formatted syntax string
-