Class CmdLineParser

java.lang.Object
org.kohsuke.args4j.CmdLineParser
org.eclipse.jgit.pgm.opt.CmdLineParser
Direct Known Subclasses:
Main.SubcommandLineParser

public class CmdLineParser extends org.kohsuke.args4j.CmdLineParser
Extended command line parser which handles --foo=value arguments.

The args4j package does not natively handle --foo=value and instead prefers to see --foo value on the command line. Many users are used to the GNU style --foo=value long option, so we convert from the GNU style format to the args4j style format prior to invoking args4j for parsing.

  • Field Details

  • Constructor Details

    • CmdLineParser

      public CmdLineParser(Object bean)
      Creates a new command line owner that parses arguments/options and set them into the given object.
      Parameters:
      bean - instance of a class annotated by Option and Argument. this object will receive values.
      Throws:
      org.kohsuke.args4j.IllegalAnnotationError - if the option bean class is using args4j annotations incorrectly.
    • CmdLineParser

      public CmdLineParser(Object bean, Repository repo)
      Creates a new command line owner that parses arguments/options and set them into the given object.
      Parameters:
      bean - instance of a class annotated by Option and Argument. this object will receive values.
      repo - repository this parser can translate options through.
      Throws:
      org.kohsuke.args4j.IllegalAnnotationError - if the option bean class is using args4j annotations incorrectly.
  • Method Details

    • parseArgument

      public void parseArgument(String... args) throws org.kohsuke.args4j.CmdLineException
      Overrides:
      parseArgument in class org.kohsuke.args4j.CmdLineParser
      Throws:
      org.kohsuke.args4j.CmdLineException
    • printToErrorWriter

      private void printToErrorWriter(String error)
    • unsetRequiredOptions

      private List<org.kohsuke.args4j.spi.OptionHandler> unsetRequiredOptions()
    • restoreRequiredOptions

      private void restoreRequiredOptions(List<org.kohsuke.args4j.spi.OptionHandler> backup)
    • containsHelp

      protected boolean containsHelp(String... args)
      Check if array contains help option
      Parameters:
      args - non null
      Returns:
      true if the given array contains help option
      Since:
      4.2
    • getRepository

      public Repository getRepository()
      Get the repository this parser translates values through.
      Returns:
      the repository, if specified during construction.
    • getRevWalk

      public RevWalk getRevWalk()
      Get the revision walker used to support option parsing.
      Returns:
      the revision walk used by this option parser.
    • getRevWalkGently

      public RevWalk getRevWalkGently()
      Get the revision walker used to support option parsing.

      This method does not initialize the RevWalk and may return null.

      Returns:
      the revision walk used by this option parser, or null.
    • createOptionHandler

      protected org.kohsuke.args4j.spi.OptionHandler createOptionHandler(org.kohsuke.args4j.OptionDef o, org.kohsuke.args4j.spi.Setter setter)
      Overrides:
      createOptionHandler in class org.kohsuke.args4j.CmdLineParser
    • printSingleLineUsage

      public void printSingleLineUsage(Writer w, ResourceBundle rb)
      Overrides:
      printSingleLineUsage in class org.kohsuke.args4j.CmdLineParser
    • sortRestOfArgumentsHandlerToTheEnd

      private boolean sortRestOfArgumentsHandlerToTheEnd(List<org.kohsuke.args4j.spi.OptionHandler> options)