Package cloud.commandframework.arguments

Class StandardCommandSyntaxFormatter.FormattingInstance

  • Enclosing class:
    StandardCommandSyntaxFormatter<C>
    public static class StandardCommandSyntaxFormatter.FormattingInstance
extends java.lang.Object
    Instance that is used when building command syntax

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected FormattingInstance()
      Create a new formatting instance

    • Constructor Detail

      • FormattingInstance

        protected FormattingInstance()
        Create a new formatting instance

    • Method Detail

      • toString

        public final @NonNull java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • appendLiteral

        public void appendLiteral​(@NonNull StaticArgument<?> literal)
        Append a literal to the syntax string
        Parameters:
        literal - Literal to append

      • appendCompound

        public void appendCompound​(@NonNull CompoundArgument<?,​?,​?> argument)
        Append a compound argument to the syntax string
        Parameters:
        argument - Compound argument to append

      • appendFlag

        public void appendFlag​(@NonNull FlagArgument<?> flagArgument)
        Append a flag argument
        Parameters:
        flagArgument - Flag argument

      • appendRequired

        public void appendRequired​(@NonNull CommandArgument<?,​?> argument)
        Append a required argument
        Parameters:
        argument - Required argument

      • appendOptional

        public void appendOptional​(@NonNull CommandArgument<?,​?> argument)
        Append an optional argument
        Parameters:
        argument - Optional argument

      • appendPipe

        public void appendPipe()
        Append the pipe (|) character

      • appendName

        public void appendName​(@NonNull java.lang.String name)
        Append an argument name
        Parameters:
        name - Name to append

      • getRequiredPrefix

        public @NonNull java.lang.String getRequiredPrefix()
        Get the required argument prefix
        Returns:
        Required argument prefix

      • getRequiredSuffix

        public @NonNull java.lang.String getRequiredSuffix()
        Get the required argument suffix
        Returns:
        Required argument suffix

      • getOptionalPrefix

        public @NonNull java.lang.String getOptionalPrefix()
        Get the optional argument prefix
        Returns:
        Optional argument prefix

      • getOptionalSuffix

        public @NonNull java.lang.String getOptionalSuffix()
        Get the optional argument suffix
        Returns:
        Optional argument suffix

      • appendBlankSpace

        public void appendBlankSpace()
        Append a blank space