Package org.incendo.cloud.syntax

Class StandardCommandSyntaxFormatter.FormattingInstance

java.lang.Object
org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance
Enclosing class:
StandardCommandSyntaxFormatter<C>
@API(status=STABLE) public static class StandardCommandSyntaxFormatter.FormattingInstance extends Object
Instance that is used when building command syntax

  • Constructor Details

    • FormattingInstance

      protected FormattingInstance()
      Create a new formatting instance

  • Method Details

    • toString

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

    • appendLiteral

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

    • appendAggregate

      @API(status=STABLE) public void appendAggregate(@NonNull CommandComponent<?> component, @NonNull AggregateParser<?,?> parser)
      Append an aggregate component to the syntax string
      Parameters:
      component - The component that contained the argument
      parser - Compound argument to append

    • appendFlag

      public void appendFlag(@NonNull CommandFlagParser<?> flagParser)
      Appends a flag argument
      Parameters:
      flagParser - flag parser

    • appendRequired

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

    • appendOptional

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

    • appendPipe

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

    • appendName

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

    • requiredPrefix

      public @NonNull String requiredPrefix()
      Get the required argument prefix
      Returns:
      Required argument prefix

    • requiredSuffix

      public @NonNull String requiredSuffix()
      Get the required argument suffix
      Returns:
      Required argument suffix

    • optionalPrefix

      public @NonNull String optionalPrefix()
      Get the optional argument prefix
      Returns:
      Optional argument prefix

    • optionalSuffix

      public @NonNull String optionalSuffix()
      Get the optional argument suffix
      Returns:
      Optional argument suffix

    • appendBlankSpace

      public void appendBlankSpace()
      Append a blank space