Package cloud.commandframework.arguments
Class StandardCommandSyntaxFormatter<C>
java.lang.Object
cloud.commandframework.arguments.StandardCommandSyntaxFormatter<C>
- Type Parameters:
C
- Command sender type
- All Implemented Interfaces:
CommandSyntaxFormatter<C>
@API(status=INTERNAL,
consumers="cloud.commandframework.*")
public class StandardCommandSyntaxFormatter<C>
extends Object
implements CommandSyntaxFormatter<C>
CommandSyntaxFormatter
implementation that uses the following rules:
- static arguments are serialized as their name, without a bracket
- required arguments are serialized as their name, surrounded by angle brackets
- optional arguments are serialized as their name, surrounded by square brackets
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Instance that is used when building command syntax -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal @NonNull String
apply
(@NonNull List<@NonNull CommandArgument<C, ?>> commandArguments, @Nullable CommandTree.Node<@Nullable CommandArgument<C, ?>> node) Format the command arguments into a syntax stringprotected @NonNull StandardCommandSyntaxFormatter.FormattingInstance
Create a new formatting instance
-
Constructor Details
-
StandardCommandSyntaxFormatter
public StandardCommandSyntaxFormatter()
-
-
Method Details
-
apply
public final @NonNull String apply(@NonNull List<@NonNull CommandArgument<C, ?>> commandArguments, @Nullable CommandTree.Node<@Nullable CommandArgument<C, ?>> node) Format the command arguments into a syntax string- Specified by:
apply
in interfaceCommandSyntaxFormatter<C>
- 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
-
createInstance
Create a new formatting instance- Returns:
- Formatting instance
-