A B C D E F G H I J K L M N O P Q R S T U V W
All Classes All Packages

H

handle(CommandLine.ParseResult) - Method in class picocli.CommandLine.AbstractParseResultHandler

Deprecated.

Processes the specified ParseResult and returns the result as a list of objects.

handle(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunAll

Executes the top-level command and all subcommands as Runnable or Callable.

handle(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunFirst

Executes the top-level Runnable or Callable subcommand.

handle(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunLast

Executes the most specific Runnable or Callable subcommand.

handleCommands(Map<Element, CommandLine.Model.CommandSpec>, Set<? extends TypeElement>, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor

Subclasses must implement this method and do something with the CommandSpec command model objects that were found during compilation.

handleException(CommandLine.ParameterException, PrintStream, CommandLine.Help.Ansi, String...) - Method in class picocli.CommandLine.DefaultExceptionHandler

Deprecated.

handleException(CommandLine.ParameterException, PrintStream, CommandLine.Help.Ansi, String...) - Method in interface picocli.CommandLine.IExceptionHandler

Deprecated.

Handles a ParameterException that occurred while parsing the command line arguments and optionally returns a list of results.

handleExecutionException(Exception, CommandLine, CommandLine.ParseResult) - Method in interface picocli.CommandLine.IExecutionExceptionHandler

Handles an Exception that occurred while executing the Runnable or Callable command and returns an exit code suitable for returning from CommandLine.execute(String...).

handleExecutionException(CommandLine.ExecutionException, CommandLine.ParseResult) - Method in class picocli.CommandLine.DefaultExceptionHandler

Deprecated.

This implementation always simply rethrows the specified exception.

handleExecutionException(CommandLine.ExecutionException, CommandLine.ParseResult) - Method in interface picocli.CommandLine.IExceptionHandler2

Deprecated.

Handles a ExecutionException that occurred while executing the Runnable or Callable command and optionally returns a list of results.

handleExecutionException(CommandLine, String[], Exception) - Method in class picocli.groovy.PicocliBaseScript

Deprecated.

If an Exception occurs during PicocliBaseScript.runRunnableSubcommand(List), or PicocliBaseScript.runScriptBody() then this gets called to report the problem.

handleParameterException(CommandLine.ParameterException, String[]) - Method in class picocli.groovy.PicocliBaseScript

Deprecated.

If a ParameterException occurs during PicocliBaseScript.parseScriptArguments(CommandLine, String[]) then this method gets called to report the problem.

handleParseException(CommandLine.ParameterException, String[]) - Method in class picocli.CommandLine.DefaultExceptionHandler

Deprecated.

Prints the message of the specified exception, followed by the usage message for the command or subcommand whose input was invalid, to the stream returned by CommandLine.AbstractHandler.err().

handleParseException(CommandLine.ParameterException, String[]) - Method in interface picocli.CommandLine.IExceptionHandler2

Deprecated.

Handles a ParameterException that occurred while parsing the command line arguments and optionally returns a list of results.

handleParseException(CommandLine.ParameterException, String[]) - Method in interface picocli.CommandLine.IParameterExceptionHandler

Handles a ParameterException that occurred while parsing the command line arguments and returns an exit code suitable for returning from CommandLine.execute(String...).

handleParseResult(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in interface picocli.CommandLine.IParseResultHandler

Deprecated.

Processes a List of CommandLine objects resulting from successfully parsing the command line arguments and optionally returns a list of results.

handleParseResult(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine.RunAll

Prints help if requested, and otherwise executes the top-level command and all subcommands as Runnable, Callable or Method.

handleParseResult(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine.RunFirst

Prints help if requested, and otherwise executes the top-level Runnable or Callable command.

handleParseResult(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine.RunLast

Prints help if requested, and otherwise executes the most specific Runnable or Callable subcommand.

handleParseResult(CommandLine.ParseResult) - Method in class picocli.CommandLine.AbstractParseResultHandler

Deprecated.

Prints help if requested, and otherwise calls CommandLine.AbstractParseResultHandler.handle(CommandLine.ParseResult).

handleParseResult(CommandLine.ParseResult) - Method in interface picocli.CommandLine.IParseResultHandler2

Deprecated.

Processes the ParseResult object resulting from successfully parsing the command line arguments and returns a return value.

hasAtFileParameter() - Method in class picocli.CommandLine.Help

Returns true if the usage help should show the at file parameter in the parameter list, otherwise false.

hasCommand(String) - Method in class picocli.shell.jline3.PicocliCommands

hasExitCode() - Method in class picocli.CommandLine.AbstractHandler

Deprecated.

Returns true if an exit code was set with CommandLine.AbstractHandler.andExit(int), or false (the default) if the handler should not call System.exit(int) after processing completes.

hashCode() - Method in class picocli.CommandLine.Help.Ansi.Text

hashCode() - Method in class picocli.CommandLine.Help.ColorScheme

hashCode() - Method in class picocli.CommandLine.Help.Column

hashCode() - Method in class picocli.CommandLine.Model.ArgGroupSpec

hashCode() - Method in class picocli.CommandLine.Model.OptionSpec

hashCode() - Method in class picocli.CommandLine.Model.PositionalParamSpec

hashCode() - Method in class picocli.CommandLine.Range

hashCode(boolean) - Static method in class picocli.codegen.util.Assert

hashCode(Object) - Static method in class picocli.codegen.util.Assert

hashCodeImpl() - Method in class picocli.CommandLine.Model.ArgSpec

hasInitialValue() - Method in class picocli.CommandLine.Model.ArgSpec

Determines whether the option or positional parameter will be reset to the CommandLine.Model.ArgSpec.initialValue() before parsing new input.

hasInitialValue() - Method in interface picocli.CommandLine.Model.IAnnotatedElement

hasMatchedOption(char) - Method in class picocli.CommandLine.ParseResult

Returns whether an option whose aliases include the specified short name was matched on the command line.

hasMatchedOption(String) - Method in class picocli.CommandLine.ParseResult

Returns whether an option whose aliases include the specified name was matched on the command line.

hasMatchedOption(CommandLine.Model.OptionSpec) - Method in class picocli.CommandLine.ParseResult

Returns whether the specified option was matched on the command line.

hasMatchedPositional(int) - Method in class picocli.CommandLine.ParseResult

Returns whether a positional parameter was matched at the specified position.

hasMatchedPositional(CommandLine.Model.PositionalParamSpec) - Method in class picocli.CommandLine.ParseResult

Returns whether the specified positional parameter was matched on the command line.

hasSubcommand() - Method in class picocli.CommandLine.ParseResult

Returns true if a subcommand was matched on the command line, false otherwise.

header() - Method in annotation type picocli.CommandLine.Command

Optional summary description of the command, shown before the synopsis.

header() - Method in class picocli.CommandLine.Model.UsageMessageSpec

Returns the optional header lines displayed at the top of the help message.

header(Object...) - Method in class picocli.CommandLine.Help

Returns the command header text as a string.

header(String...) - Method in class picocli.CommandLine.Model.UsageMessageSpec

Sets the optional header lines displayed at the top of the help message.

headerHeading() - Method in annotation type picocli.CommandLine.Command

Set the heading preceding the header section.

headerHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec

Returns the optional heading preceding the header section.

headerHeading(Object...) - Method in class picocli.CommandLine.Help

Returns the text displayed before the header text; the result of String.format(headerHeading, params).

headerHeading(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec

Sets the heading preceding the header section.

heading() - Method in annotation type picocli.CommandLine.ArgGroup

The heading of this group, used when generating the usage documentation.

heading() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder

Returns the heading of this group, used when generating the usage documentation.

heading() - Method in class picocli.CommandLine.Model.ArgGroupSpec

Returns the heading of this group (may be null), used when generating the usage documentation.

heading(String) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder

Sets the heading of this group (may be null), used when generating the usage documentation.

headingKey() - Method in annotation type picocli.CommandLine.ArgGroup

ResourceBundle key for this group's usage help message section heading.

headingKey() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder

Returns the heading key of this group, used to get the heading from a resource bundle.

headingKey() - Method in class picocli.CommandLine.Model.ArgGroupSpec

Returns the heading key of this group (may be null), used to get the heading from a resource bundle.

headingKey(String) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder

Sets the heading key of this group, used to get the heading from a resource bundle.

help() - Method in class picocli.CommandLine.Model.OptionSpec.Builder

Deprecated.

Use CommandLine.Model.OptionSpec.Builder.usageHelp() and CommandLine.Model.OptionSpec.Builder.versionHelp() instead.

help() - Method in class picocli.CommandLine.Model.OptionSpec

Deprecated.

Use CommandLine.Model.OptionSpec.usageHelp() and CommandLine.Model.OptionSpec.versionHelp() instead.

help() - Method in annotation type picocli.CommandLine.Option

This should rarely be used: the recommended attributes are usageHelp and versionHelp.

help(boolean) - Method in class picocli.CommandLine.Model.OptionSpec.Builder

Sets whether this option disables validation of the other arguments, and returns this builder.

Help(Object) - Constructor for class picocli.CommandLine.Help

Constructs a new Help instance with a default color scheme, initialized from annotations on the specified class and superclasses.

Help(Object, CommandLine.Help.Ansi) - Constructor for class picocli.CommandLine.Help

Constructs a new Help instance with a default color scheme, initialized from annotations on the specified class and superclasses.

Help(Object, CommandLine.Help.ColorScheme) - Constructor for class picocli.CommandLine.Help

Deprecated.

use Help(picocli.CommandLine.Model.CommandSpec, picocli.CommandLine.Help.ColorScheme)

Help(CommandLine.Model.CommandSpec, CommandLine.Help.ColorScheme) - Constructor for class picocli.CommandLine.Help

Constructs a new Help instance with the specified color scheme, initialized from annotations on the specified class and superclasses.

helpCommand() - Method in annotation type picocli.CommandLine.Command

Set this attribute to true if this subcommand is a help command, and required options and positional parameters of the parent command should not be validated.

helpCommand() - Method in class picocli.CommandLine.Model.CommandSpec

Returns whether this subcommand is a help command, and required options and positional parameters of the parent command should not be validated.

helpCommand(boolean) - Method in class picocli.CommandLine.Model.CommandSpec

Sets whether this is a help command and required parameter checking should be suspended.

HelpCommand() - Constructor for class picocli.CommandLine.HelpCommand

helpFactory() - Method in class picocli.CommandLine.Model.UsageMessageSpec

Returns the IHelpFactory that is used to construct the usage help message.

helpFactory(CommandLine.IHelpFactory) - Method in class picocli.CommandLine.Model.UsageMessageSpec

Sets a new IHelpFactory to customize the usage help message.

hidden() - Method in annotation type picocli.CommandLine.Command

Set hidden=true if this command should not be included in the list of commands in the usage help of the parent command.

hidden() - Method in class picocli.CommandLine.Model.ArgSpec

Returns whether this option should be excluded from the usage message.

hidden() - Method in class picocli.CommandLine.Model.UsageMessageSpec

Returns whether this command should be hidden from the usage help message of the parent command.

hidden() - Method in annotation type picocli.CommandLine.Option

Set hidden=true if this option should not be included in the usage help message.

hidden() - Method in annotation type picocli.CommandLine.Parameters

Set hidden=true if this parameter should not be included in the usage message.

hidden(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec

Set the hidden flag on this command to control whether to show or hide it in the help usage text of the parent command.

hideParamSyntax() - Method in class picocli.CommandLine.Model.ArgSpec

Returns whether usage syntax decorations around the paramLabel should be suppressed.

hideParamSyntax() - Method in annotation type picocli.CommandLine.Option

Returns whether usage syntax decorations around the paramLabel should be suppressed.

hideParamSyntax() - Method in annotation type picocli.CommandLine.Parameters

Returns whether usage syntax decorations around the paramLabel should be suppressed.

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes All Packages