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>

public class StandardCommandSyntaxFormatter<C>
extends java.lang.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

Nested Classes

Modifier and Type	Class	Description
static class	StandardCommandSyntaxFormatter.FormattingInstance	Instance that is used when building command syntax

Constructor Summary

Constructors

Constructor	Description
StandardCommandSyntaxFormatter()

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
protected @NonNull StandardCommandSyntaxFormatter.FormattingInstance	createInstance()	Create a new formatting instance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StandardCommandSyntaxFormatter

public StandardCommandSyntaxFormatter()

Method Detail

apply

public final @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

Specified by:

apply in interface CommandSyntaxFormatter<C>

Parameters:

commandArguments - Command arguments

node - Trailing node

Returns:

Syntax string

createInstance

protected @NonNull StandardCommandSyntaxFormatter.FormattingInstance createInstance()

Create a new formatting instance

Returns:

Formatting instance