Package org.eclipse.jgit.pgm.opt
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.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate TextBuiltin
private final Repository
private boolean
private RevWalk
-
Constructor Summary
ConstructorsConstructorDescriptionCmdLineParser
(Object bean) Creates a new command line owner that parses arguments/options and set them into the given object.CmdLineParser
(Object bean, Repository repo) Creates a new command line owner that parses arguments/options and set them into the given object. -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
containsHelp
(String... args) Check if array contains help optionprotected org.kohsuke.args4j.spi.OptionHandler
createOptionHandler
(org.kohsuke.args4j.OptionDef o, org.kohsuke.args4j.spi.Setter setter) Get the repository this parser translates values through.Get the revision walker used to support option parsing.Get the revision walker used to support option parsing.void
parseArgument
(String... args) void
private void
printToErrorWriter
(String error) private void
restoreRequiredOptions
(List<org.kohsuke.args4j.spi.OptionHandler> backup) private boolean
sortRestOfArgumentsHandlerToTheEnd
(List<org.kohsuke.args4j.spi.OptionHandler> options) private List<org.kohsuke.args4j.spi.OptionHandler>
Methods inherited from class org.kohsuke.args4j.CmdLineParser
addArgument, addOption, getArguments, getOptions, getProperties, isOption, parseArgument, printExample, printExample, printExample, printExample, printOption, printSingleLineUsage, printUsage, printUsage, printUsage, registerHandler, setUsageWidth, stopOptionParsing
-
Field Details
-
db
-
walk
-
seenHelp
private boolean seenHelp -
cmd
-
-
Constructor Details
-
CmdLineParser
Creates a new command line owner that parses arguments/options and set them into the given object.- Parameters:
bean
- instance of a class annotated byOption
andArgument
. this object will receive values.- Throws:
org.kohsuke.args4j.IllegalAnnotationError
- if the option bean class is using args4j annotations incorrectly.
-
CmdLineParser
Creates a new command line owner that parses arguments/options and set them into the given object.- Parameters:
bean
- instance of a class annotated byOption
andArgument
. 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
- Overrides:
parseArgument
in classorg.kohsuke.args4j.CmdLineParser
- Throws:
org.kohsuke.args4j.CmdLineException
-
printToErrorWriter
-
unsetRequiredOptions
-
restoreRequiredOptions
-
containsHelp
Check if array contains help option- Parameters:
args
- non null- Returns:
- true if the given array contains help option
- Since:
- 4.2
-
getRepository
Get the repository this parser translates values through.- Returns:
- the repository, if specified during construction.
-
getRevWalk
Get the revision walker used to support option parsing.- Returns:
- the revision walk used by this option parser.
-
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 classorg.kohsuke.args4j.CmdLineParser
-
printSingleLineUsage
- Overrides:
printSingleLineUsage
in classorg.kohsuke.args4j.CmdLineParser
-
sortRestOfArgumentsHandlerToTheEnd
private boolean sortRestOfArgumentsHandlerToTheEnd(List<org.kohsuke.args4j.spi.OptionHandler> options)
-