Package org.apache.camel.tooling.model

Class JBangCommandModel.JBangCommand

java.lang.Object
org.apache.camel.tooling.model.JBangCommandModel.JBangCommand
Enclosing class:
JBangCommandModel
public static class JBangCommandModel.JBangCommand extends Object
Represents a JBang CLI command.

  • Constructor Details

    • JBangCommand

      public JBangCommand()

    • JBangCommand

      public JBangCommand(String name, String description)

  • Method Details

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getFullName

      public String getFullName()

    • setFullName

      public void setFullName(String fullName)

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • isDeprecated

      public boolean isDeprecated()

    • setDeprecated

      public void setDeprecated(boolean deprecated)

    • getDeprecationNote

      public String getDeprecationNote()

    • setDeprecationNote

      public void setDeprecationNote(String deprecationNote)

    • getSourceClass

      public String getSourceClass()

    • setSourceClass

      public void setSourceClass(String sourceClass)

    • getExamples

      public String getExamples()

    • setExamples

      public void setExamples(String examples)

    • hasExamples

      public boolean hasExamples()

    • getOptions

      public List<JBangCommandModel.JBangCommandOption> getOptions()

    • addOption

      public void addOption(JBangCommandModel.JBangCommandOption option)

    • getSubcommands

      public List<JBangCommandModel.JBangCommand> getSubcommands()

    • addSubcommand

      public void addSubcommand(JBangCommandModel.JBangCommand subcommand)

    • hasSubcommands

      public boolean hasSubcommands()

    • hasOptions

      public boolean hasOptions()

    • getDocFileName

      public String getDocFileName()
      Gets the file name (without path) for this command's documentation page.

    • getDocFilePath

      public String getDocFilePath()
      Gets the relative path (including subfolder) for this command's documentation page.

    • getDocXref

      public String getDocXref()
      Gets the xref path for linking to this command's documentation page.