Package io.quarkus.deployment.builditem

Class ConsoleCommandBuildItem

java.lang.Object
io.quarkus.builder.item.BuildItem
io.quarkus.builder.item.MultiBuildItem
io.quarkus.deployment.builditem.ConsoleCommandBuildItem
public final class ConsoleCommandBuildItem extends io.quarkus.builder.item.MultiBuildItem
A MultiBuildItem used to register console commands.

Extensions can produce this build item to contribute AEsh commands that are made available in the Quarkus interactive console.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    (package private) final org.aesh.command.container.CommandContainer
    consoleCommand
    The command container registered by this build item.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConsoleCommandBuildItem(org.aesh.command.Command<?> consoleCommand)
    Creates a build item from a command implementation.
    ConsoleCommandBuildItem(org.aesh.command.container.CommandContainer consoleCommand)
    Creates a build item from an already built CommandContainer.
    ConsoleCommandBuildItem(org.aesh.command.impl.internal.ProcessedCommand consoleCommand)
    Creates a build item from an AEsh ProcessedCommand.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.aesh.command.container.CommandContainer
    getConsoleCommand()
     

    Methods inherited from class java.lang.Object

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

  • Field Details

    • consoleCommand

      final org.aesh.command.container.CommandContainer consoleCommand
      The command container registered by this build item. This is the actual command that will be executed when the user invokes the command in the console.

  • Constructor Details

    • ConsoleCommandBuildItem

      public ConsoleCommandBuildItem(org.aesh.command.container.CommandContainer consoleCommand)
      Creates a build item from an already built CommandContainer.
      Parameters:
      consoleCommand - the command container to register

    • ConsoleCommandBuildItem

      public ConsoleCommandBuildItem(org.aesh.command.impl.internal.ProcessedCommand consoleCommand)
      Creates a build item from an AEsh ProcessedCommand.
      Parameters:
      consoleCommand - the processed command metadata

    • ConsoleCommandBuildItem

      public ConsoleCommandBuildItem(org.aesh.command.Command<?> consoleCommand)
      Creates a build item from a command implementation.
      Parameters:
      consoleCommand - the command implementation to register

  • Method Details

    • getConsoleCommand

      public org.aesh.command.container.CommandContainer getConsoleCommand()
      Returns:
      the command container registered by this build item