CommandLine |
CommandLine.addMixin(java.lang.String name,
java.lang.Object mixin) |
Adds the options and positional parameters in the specified mixin to this command.
|
CommandLine |
CommandLine.addSubcommand(java.lang.Object command) |
Registers a subcommand with the name obtained from the @Command(name = "...") annotation attribute of the specified command.
|
CommandLine |
CommandLine.addSubcommand(java.lang.String name,
java.lang.Object command) |
Registers a subcommand with the specified name.
|
CommandLine |
CommandLine.addSubcommand(java.lang.String name,
java.lang.Object command,
java.lang.String... aliases) |
Registers a subcommand with the specified name and all specified aliases.
|
CommandLine |
CommandLine.Model.CommandSpec.commandLine() |
Returns the CommandLine constructed with this CommandSpec model.
|
CommandLine |
CommandLine.ExecutionException.getCommandLine() |
Returns the CommandLine object for the (sub)command that could not be invoked.
|
CommandLine |
CommandLine.ParameterException.getCommandLine() |
Returns the CommandLine object for the (sub)command whose input could not be parsed.
|
CommandLine |
CommandLine.getParent() |
Returns the command that this is a subcommand of, or null if this is a top-level command.
|
<K> CommandLine |
CommandLine.registerConverter(java.lang.Class<K> cls,
CommandLine.ITypeConverter<K> converter) |
Registers the specified type converter for the specified class.
|
CommandLine |
CommandLine.Model.CommandSpec.removeSubcommand(java.lang.String name) |
Removes the subcommand with the specified name or alias from this CommandSpec and
returns the CommandLine instance that was associated with the specified name,
or null of the specified name was not associated with a subcommand.
|
CommandLine |
CommandLine.setAbbreviatedOptionsAllowed(boolean newValue) |
Sets whether abbreviated option names should be matched.
|
CommandLine |
CommandLine.setAbbreviatedSubcommandsAllowed(boolean newValue) |
Sets whether abbreviated subcommands should be matched.
|
CommandLine |
CommandLine.setAdjustLineBreaksForWideCJKCharacters(boolean adjustForWideChars) |
Sets whether line breaks should take wide Chinese, Japanese and Korean characters into account, and returns this UsageMessageSpec.
|
CommandLine |
CommandLine.setAllowOptionsAsOptionParameters(boolean newValue) |
Sets whether options can have parameter values that match the name of an option in this command, or whether such values should be rejected with a missing parameter exception.
|
CommandLine |
CommandLine.setAllowSubcommandsAsOptionParameters(boolean newValue) |
Sets whether options can have parameter values that match subcommand names or aliases, or whether such values should be rejected with a missing parameter exception.
|
CommandLine |
CommandLine.setAtFileCommentChar(java.lang.Character atFileCommentChar) |
Sets the character that starts a single-line comment or null if all content of argument files should
be interpreted as arguments (without comments).
|
CommandLine |
CommandLine.setCaseInsensitiveEnumValuesAllowed(boolean newValue) |
Sets whether the parser should ignore case when converting arguments to enum values.
|
CommandLine |
CommandLine.setColorScheme(CommandLine.Help.ColorScheme colorScheme) |
Sets the color scheme to use when printing help.
|
CommandLine |
CommandLine.setCommandName(java.lang.String commandName) |
Sets the command name (also called program name) displayed in the usage help synopsis to the specified value.
|
CommandLine |
CommandLine.setDefaultValueProvider(CommandLine.IDefaultValueProvider newValue) |
Sets a default value provider for the command and sub-commands
|
CommandLine |
CommandLine.setEndOfOptionsDelimiter(java.lang.String delimiter) |
Sets the end-of-options delimiter that signals that the remaining command line arguments should be treated as positional parameters.
|
CommandLine |
CommandLine.setErr(java.io.PrintWriter err) |
Sets the writer to use when printing diagnostic (error) messages during command execution.
|
CommandLine |
CommandLine.setExecutionExceptionHandler(CommandLine.IExecutionExceptionHandler executionExceptionHandler) |
Sets a custom handler for dealing with exceptions that occurred in the Callable , Runnable or Method
user object of a command when the command was executed via the execute method.
|
CommandLine |
CommandLine.setExecutionStrategy(CommandLine.IExecutionStrategy executionStrategy) |
Sets the execution strategy that the execute method should use to invoke
the business logic on the user objects of this command and/or the user-specified subcommand(s).
|
CommandLine |
CommandLine.setExitCodeExceptionMapper(CommandLine.IExitCodeExceptionMapper exitCodeExceptionMapper) |
Sets the mapper used by the execute method to map exceptions to exit codes.
|
CommandLine |
CommandLine.setExpandAtFiles(boolean expandAtFiles) |
Sets whether arguments starting with '@' should be treated as the path to an argument file and its
contents should be expanded into separate arguments for each line in the specified file.
|
CommandLine |
CommandLine.setHelpFactory(CommandLine.IHelpFactory helpFactory) |
Sets a new IHelpFactory to customize the usage help message.
|
CommandLine |
CommandLine.setHelpSectionKeys(java.util.List<java.lang.String> keys) |
Sets the section keys in the order that the usage help message should render the sections.
|
CommandLine |
CommandLine.setHelpSectionMap(java.util.Map<java.lang.String,CommandLine.IHelpSectionRenderer> map) |
Sets the map of section keys and renderers used to construct the usage help message.
|
CommandLine |
CommandLine.setInterpolateVariables(boolean interpolate) |
Sets whether variables should be interpolated in String values.
|
CommandLine |
CommandLine.setNegatableOptionTransformer(CommandLine.INegatableOptionTransformer transformer) |
Sets the INegatableOptionTransformer used to create the negative form of negatable options.
|
CommandLine |
CommandLine.setOptionsCaseInsensitive(boolean newValue) |
Sets whether upper case and lower case should be ignored when matching option names.
|
CommandLine |
CommandLine.setOut(java.io.PrintWriter out) |
Sets the writer to use when printing user-requested usage help or version help during command execution.
|
CommandLine |
CommandLine.setOverwrittenOptionsAllowed(boolean newValue) |
|
CommandLine |
CommandLine.setParameterExceptionHandler(CommandLine.IParameterExceptionHandler parameterExceptionHandler) |
Sets the handler for dealing with invalid user input when the command is executed.
|
CommandLine |
CommandLine.setPosixClusteredShortOptionsAllowed(boolean newValue) |
Sets whether short options like -x -v -f SomeFile can be clustered together like -xvfSomeFile .
|
CommandLine |
CommandLine.setResourceBundle(java.util.ResourceBundle bundle) |
Sets the ResourceBundle containing usage help message strings.
|
CommandLine |
CommandLine.setSeparator(java.lang.String separator) |
Sets the String the parser uses to separate option names from option values to the specified value.
|
CommandLine |
CommandLine.setSplitQuotedStrings(boolean newValue) |
Deprecated.
|
CommandLine |
CommandLine.setStopAtPositional(boolean newValue) |
Sets whether the parser interprets the first positional parameter as "end of options" so the remaining
arguments are all treated as positional parameters.
|
CommandLine |
CommandLine.setStopAtUnmatched(boolean newValue) |
Sets whether the parser should stop interpreting options and positional parameters as soon as it encounters an
unmatched option.
|
CommandLine |
CommandLine.setSubcommandsCaseInsensitive(boolean newValue) |
Sets whether upper case and lower case should be ignored when matching subcommands.
|
CommandLine |
CommandLine.setToggleBooleanFlags(boolean newValue) |
Sets whether the value of boolean flag options should be "toggled" when the option is matched.
|
CommandLine |
CommandLine.setTrimQuotes(boolean newValue) |
Sets whether the parser should trim quotes from command line arguments before processing them.
|
CommandLine |
CommandLine.setUnmatchedArgumentsAllowed(boolean newValue) |
|
CommandLine |
CommandLine.setUnmatchedOptionsAllowedAsOptionParameters(boolean newValue) |
Sets whether options can have parameter values that resemble an option, or whether such values should be rejected as unknown options.
|
CommandLine |
CommandLine.setUnmatchedOptionsArePositionalParams(boolean newValue) |
Sets whether arguments on the command line that resemble an option should be treated as positional parameters.
|
CommandLine |
CommandLine.setUsageHelpAutoWidth(boolean detectTerminalSize) |
Sets whether picocli should attempt to detect the terminal size and adjust the usage help message width
to take the full terminal width.
|
CommandLine |
CommandLine.setUsageHelpLongOptionsMaxWidth(int columnWidth) |
Returns the maximum usage help long options column max width to the specified value.
|
CommandLine |
CommandLine.setUsageHelpWidth(int width) |
Sets the maximum width of the usage help message.
|
CommandLine |
CommandLine.setUseSimplifiedAtFiles(boolean simplifiedAtFiles) |
Sets whether to use a simplified argument file format that is compatible with JCommander.
|