Package org.incendo.cloud.syntax

Class StandardCommandSyntaxFormatter<C>

java.lang.Object

org.incendo.cloud.syntax.StandardCommandSyntaxFormatter<C>

Type Parameters:

C - command sender type

All Implemented Interfaces:

CommandSyntaxFormatter<C>

@API(status=INTERNAL,
     consumers="org.incendo.cloud.*")
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
• does not render arguments the sender does not have access to (either due to permission or sender type requirements)

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(@NonNull CommandManager<C> manager)	Creates a new StandardCommandSyntaxFormatter.

Method Summary

Modifier and Type	Method	Description
final @NonNull String	apply(@Nullable C sender, @NonNull List<@NonNull CommandComponent<C>> commandComponents, @Nullable CommandNode<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 Details

StandardCommandSyntaxFormatter

public StandardCommandSyntaxFormatter(@NonNull CommandManager<C> manager)

Creates a new StandardCommandSyntaxFormatter.

Parameters:

manager - command manager

Method Details

apply

public final @NonNull String apply(@Nullable C sender,
 @NonNull List<@NonNull CommandComponent<C>> commandComponents,
 @Nullable CommandNode<C> node)

Format the command arguments into a syntax string

Specified by:

apply in interface CommandSyntaxFormatter<C>

Parameters:

sender - The sender to format syntax for.

commandComponents - 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

createInstance

protected @NonNull StandardCommandSyntaxFormatter.FormattingInstance createInstance()

Create a new formatting instance

Returns:

Formatting instance