Class CommandGroupMetadata

java.lang.Object
com.github.rvesse.airline.model.CommandGroupMetadata

public class CommandGroupMetadata extends Object
Represents meta-data about a command group
  • Field Details

  • Constructor Details

  • Method Details

    • getName

      public String getName()
      Gets the name of the group
      Returns:
      Name
    • getDescription

      public String getDescription()
      Gets the description for the group
      Returns:
      Description
    • isHidden

      public boolean isHidden()
      Gets whether the group is hidden
      Returns:
      True if hidden, false otherwise
    • getOptions

      public List<OptionMetadata> getOptions()
      Gets the group options
      Returns:
      Group options
    • getDefaultCommand

      public CommandMetadata getDefaultCommand()
      Gets the default command for the group
      Returns:
      Default command
    • getCommands

      public List<CommandMetadata> getCommands()
      Gets the commands for the group
      Returns:
      Commands
    • addCommand

      public void addCommand(CommandMetadata command)
      Adds a command to the group
      Parameters:
      command - Command
    • getSubGroups

      public List<CommandGroupMetadata> getSubGroups()
      Gets the sub-groups of this group
      Returns:
      Sub-groups
    • addSubGroup

      public void addSubGroup(CommandGroupMetadata subGroup)
      Adds a sub-group to the group
      Parameters:
      subGroup - Sub-group
    • setParent

      public void setParent(CommandGroupMetadata parent)
      Sets the parent for a group
      Parameters:
      parent - Parent group
    • getParent

      public CommandGroupMetadata getParent()
      Gets the parent group which may be null
      Returns:
      Parent group, null if a top level group
    • toString

      public String toString()
      Overrides:
      toString in class Object