Class ArgumentGroupImpl

java.lang.Object
net.sourceforge.argparse4j.internal.ArgumentGroupImpl
All Implemented Interfaces:
ArgumentGroup, MutuallyExclusiveGroup

public final class ArgumentGroupImpl extends Object implements ArgumentGroup, MutuallyExclusiveGroup
The application code must not use this class directly. This class implements both mutually exclusive group and just a conceptual group.
  • Constructor Details

  • Method Details

    • description

      public ArgumentGroupImpl description(String description)
      Description copied from interface: ArgumentGroup
      Sets description to customize help message of this group.
      Specified by:
      description in interface ArgumentGroup
      Specified by:
      description in interface MutuallyExclusiveGroup
      Parameters:
      description - The description of this group.
      Returns:
      this
    • addArgument

      public ArgumentImpl addArgument(String... nameOrFlags)
      Description copied from interface: ArgumentGroup

      Creates new Argument and adds it to the underlining parser and returns it.

      See ArgumentParser.addArgument(String...) for details.

      Specified by:
      addArgument in interface ArgumentGroup
      Specified by:
      addArgument in interface MutuallyExclusiveGroup
      Parameters:
      nameOrFlags - A name or a list of option strings of new Argument.
      Returns:
      Argument object.
    • required

      public ArgumentGroupImpl required(boolean required)
      Description copied from interface: MutuallyExclusiveGroup

      If true is given, one of the arguments in this group must be specified otherwise error will be issued.

      The default value is false.

      Specified by:
      required in interface MutuallyExclusiveGroup
      Parameters:
      required - true or false
      Returns:
      this
    • printHelp

      public void printHelp(PrintWriter writer, int format_width)
    • getIndex

      public int getIndex()
    • setIndex

      public void setIndex(int index)
    • isMutex

      public boolean isMutex()
    • setMutex

      public void setMutex(boolean mutex)
    • isRequired

      public boolean isRequired()
    • getArgs

      public List<ArgumentImpl> getArgs()
    • isSeparateHelp

      public boolean isSeparateHelp()
      Returns true if the help message for this group should be in separate group.
      Returns:
      true if the help message for this group should be in separate group.