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

A

abbreviatedOptionsAllowed() - Method in class picocli.CommandLine.Model.ParserSpec

abbreviatedOptionsAllowed(boolean) - Method in class picocli.CommandLine.Model.ParserSpec

abbreviatedSubcommandsAllowed() - Method in class picocli.CommandLine.Model.ParserSpec

abbreviatedSubcommandsAllowed(boolean) - Method in class picocli.CommandLine.Model.ParserSpec

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

Generates a generic synopsis like <command name> [OPTIONS] [PARAM1 [PARAM2]...], omitting parts that don't apply to the command (e.g., does not show [OPTIONS] if the command has no options).

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

Specify true to generate an abbreviated synopsis like "<main> [OPTIONS] [PARAMETERS...] [COMMAND]".

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

Returns whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.

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

Sets whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.

AbstractCommandSpecProcessor - Class in picocli.codegen.annotation.processing

Abstract annotation processor for @picocli.* annotations that produces a set of CommandLine.Model.CommandSpec objects built from the annotated source code.

AbstractCommandSpecProcessor() - Constructor for class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor

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

Deprecated.

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

Deprecated.

add(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Model.CommandSpec

Adds the specified option spec or positional parameter spec to the list of configured arguments to expect.

add(CommandLine.Model.ArgSpec, int) - Method in class picocli.CommandLine.ParseResult.Builder

Adds the specified OptionSpec or PositionalParamSpec to the list of options and parameters that were matched on the command line.

addAllOptions(List<CommandLine.Model.OptionSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout

Calls CommandLine.Help.Layout.addOption(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer) for all Options in the specified list.

addAllPositionalParameters(List<CommandLine.Model.PositionalParamSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout

Calls CommandLine.Help.Layout.addPositionalParameter(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer) for all positional parameters in the specified list.

addAllSubcommands(Map<String, CommandLine>) - Method in class picocli.CommandLine.Help

Registers all specified subcommands with this Help.

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

Adds the specified argument to the list of options and positional parameters that depend on this group.

addArgGroup(CommandLine.Model.ArgGroupSpec) - Method in class picocli.CommandLine.Model.CommandSpec

Adds the specified argument group to the groups in this command.

addEmptyRow() - Method in class picocli.CommandLine.Help.TextTable

Adds the required char[] slots for a new row to the CommandLine.Help.TextTable.columnValues field.

addError(CommandLine.PicocliException) - Method in class picocli.CommandLine.ParseResult.Builder

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

Specify whether methods annotated with @Command should be registered as subcommands of their enclosing @Command class.

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

Reflects on the class of the user object and registers any command methods (class methods annotated with @Command) as subcommands.

addMethodSubcommands(CommandLine.IFactory) - Method in class picocli.CommandLine.Model.CommandSpec

Reflects on the class of the user object and registers any command methods (class methods annotated with @Command) as subcommands.

addMixin(String, Object) - Method in class picocli.CommandLine

Adds the options and positional parameters in the specified mixin to this command.

addMixin(String, CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.CommandSpec

Adds the specified mixin CommandSpec object to the map of mixins for this command.

addMixin(String, CommandLine.Model.CommandSpec, CommandLine.Model.IAnnotatedElement) - Method in class picocli.CommandLine.Model.CommandSpec

Adds the specified mixin CommandSpec object to the map of mixins for this command.

addOption(CommandLine.Model.OptionSpec) - Method in class picocli.CommandLine.Model.CommandSpec

Adds the specified option spec to the list of configured arguments to expect.

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

Adds the specified OptionSpec to the list of options that were matched on the command line.

addOption(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout

Delegates to the option renderer of this layout to obtain text values for the specified CommandLine.Model.OptionSpec, and then calls the CommandLine.Help.Layout.layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][]) method to write these text values into the correct cells in the TextTable.

addOptions(List<CommandLine.Model.OptionSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout

Calls CommandLine.Help.Layout.addOption(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer) for all non-hidden Options in the list.

addParentCommandElement(CommandLine.Model.IAnnotatedElement) - Method in class picocli.CommandLine.Model.CommandSpec

Adds the specified {@literal @}ParentCommand-annotated program element to the list of elements for this command.

addPattern(String, String, String) - Method in class picocli.CommandLine.RegexTransformer.Builder

Adds the specified negative replacement and synopsis replacement for the specified regular expression.

addPositional(CommandLine.Model.PositionalParamSpec) - Method in class picocli.CommandLine.Model.CommandSpec

Adds the specified positional parameter spec to the list of configured arguments to expect.

addPositionalParam(CommandLine.Model.PositionalParamSpec, int) - Method in class picocli.CommandLine.ParseResult.Builder

Adds the specified PositionalParamSpec to the list of parameters that were matched on the command line.

addPositionalParameter(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout

Delegates to the parameter renderer of this layout to obtain text values for the specified positional parameter, and then calls CommandLine.Help.Layout.layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][]) to write these text values into the correct cells in the TextTable.

addPositionalParameters(List<CommandLine.Model.PositionalParamSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout

Calls CommandLine.Help.Layout.addPositionalParameter(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer) for all non-hidden Parameters in the list.

addRowValues(String...) - Method in class picocli.CommandLine.Help.TextTable

Delegates to CommandLine.Help.TextTable.addRowValues(CommandLine.Help.Ansi.Text...), after ensuring that multi-line values are layed out in the correct row and column.

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

Adds a new empty row, then calls putValue for each of the specified values, adding more empty rows if the return value indicates that the value spanned multiple columns or was wrapped to multiple rows.

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

Adds the specified {@literal @}Spec annotated program element to the list of spec elements for this group.

addSpecElement(CommandLine.Model.IAnnotatedElement) - Method in class picocli.CommandLine.Model.CommandSpec

Adds the specified {@literal @}Spec-annotated program element to the list of elements for this command.

addSubcommand(Object) - Method in class picocli.CommandLine

Registers a subcommand with the name obtained from the @Command(name = "...") annotation attribute of the specified command.

addSubcommand(String, Object) - Method in class picocli.CommandLine

Registers a subcommand with the specified name.

addSubcommand(String, Object) - Method in class picocli.CommandLine.Help

Deprecated.

use CommandLine.Help.addAllSubcommands(Map) instead

addSubcommand(String, Object, String...) - Method in class picocli.CommandLine

Registers a subcommand with the specified name and all specified aliases.

addSubcommand(String, CommandLine) - Method in class picocli.CommandLine.Model.CommandSpec

Adds the specified subcommand with the specified name.

addSubcommand(String, CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.CommandSpec

Adds the specified subcommand with the specified name.

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

Adds the specified group to the list of subgroups that this group is composed of.

addUnmatched(String) - Method in class picocli.CommandLine.ParseResult.Builder

Adds the specified command line argument to the list of unmatched command line arguments.

addUnmatched(Stack<String>) - Method in class picocli.CommandLine.ParseResult.Builder

Adds all elements of the specified command line arguments stack to the list of unmatched command line arguments.

addUnmatchedArgsBinding(CommandLine.Model.UnmatchedArgsBinding) - Method in class picocli.CommandLine.Model.CommandSpec

Adds the specified UnmatchedArgsBinding to the list of model objects to capture unmatched arguments for this command.

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

Returns whether line breaks should take wide Chinese, Japanese and Korean characters into account for line-breaking purposes.

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

Sets whether line breaks should take wide Chinese, Japanese and Korean characters into account, and returns this UsageMessageSpec.

afterExecution(CommandLine, int, Exception) - Method in class picocli.groovy.PicocliBaseScript2

This method is called after the script has been executed, and may do one of three things: Call System.exit with the specified exit code. Throw a GroovyRuntimeException with the specified exception. Return the result of the script execution.

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

Alternative command names by which this subcommand is recognized on the command line.

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

Returns the list of aliases for the command in this Help.

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

Returns the alias command names of this subcommand.

aliases(String...) - Method in class picocli.CommandLine.Model.CommandSpec

Sets the alternative names by which this subcommand is recognized on the command line.

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

Returns all options configured for this group and all subgroups.

allowOptionsAsOptionParameters() - Method in class picocli.CommandLine.Model.ParserSpec

allowOptionsAsOptionParameters(boolean) - Method in class picocli.CommandLine.Model.ParserSpec

allowSubcommandsAsOptionParameters() - Method in class picocli.CommandLine.Model.ParserSpec

allowSubcommandsAsOptionParameters(boolean) - Method in class picocli.CommandLine.Model.ParserSpec

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

Returns all positional parameters configured for this group and all subgroups.

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

Returns the map of all subcommand Help instances (including hidden commands) for this command Help.

ALWAYS - picocli.CommandLine.Help.Visibility

andExit(int) - Method in class picocli.CommandLine.AbstractHandler

Deprecated.

use CommandLine.execute(String...) instead, and call System.exit() in the application.

annotatedElement - Variable in class picocli.CommandLine.Model.ArgSpec

AnnotatedElementHolder - Class in picocli.codegen.annotation.processing

Implementation of the CommandLine.Model.IGetter and CommandLine.Model.ISetter interface that allows custom CommandSpec annotation processors to inspect ArgSpec objects to discover what program element was annotated with @Option or @Parameters.

AnnotatedElementHolder(Element) - Constructor for class picocli.codegen.annotation.processing.AnnotatedElementHolder

Constructs a new AnnotatedElementHolder with the specified element

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

Deprecated.

use CommandLine.AbstractHandler.colorScheme() instead

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

Returns whether ANSI escape codes are enabled or not.

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

Returns the Ansi setting of this color scheme.

ansi() - Method in class picocli.CommandLine.Help.ColorScheme.Builder

Returns the Ansi setting of this color scheme builder.

ansi(CommandLine.Help.Ansi) - Method in class picocli.CommandLine.Help.ColorScheme.Builder

Set the Ansi setting of this color scheme builder.

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

Deprecated.

use CommandLine.Help.Ansi.Text.concat(String) instead

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

Deprecated.

use CommandLine.Help.Ansi.Text.concat(CommandLine.Help.Ansi.Text) instead

apply(String, List<CommandLine.Help.Ansi.IStyle>) - Method in enum picocli.CommandLine.Help.Ansi

Deprecated.

use CommandLine.Help.ColorScheme.apply(String, List) instead

apply(String, List<CommandLine.Help.Ansi.IStyle>) - Method in class picocli.CommandLine.Help.ColorScheme

Returns a new Text object where all the specified styles are applied to the full length of the specified plain text.

applySystemProperties() - Method in class picocli.CommandLine.Help.ColorScheme.Builder

Replaces colors and styles in this scheme builder with ones specified in system properties, and returns this builder.

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

Returns the argument groups in this command.

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

Returns the options and positional parameters in this group; may be empty but not null.

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

Returns the list of options and positional parameters that depend on this group.

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

Returns the list of all options and positional parameters configured for this command.

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

Returns how many arguments this option or positional parameter requires.

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

Specifies the minimum number of required parameters and the maximum number of accepted parameters.

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

Specifies the minimum number of required parameters and the maximum number of accepted parameters.

aritySatisfiedByAttachedOptionParam() - Method in class picocli.CommandLine.Model.ParserSpec

Returns true if options with attached arguments should not consume subsequent arguments and should not validate arity.

aritySatisfiedByAttachedOptionParam(boolean) - Method in class picocli.CommandLine.Model.ParserSpec

Returns true if options with attached arguments should not consume subsequent arguments and should not validate arity.

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

Returns this ParseResult as a list of CommandLine objects, one for each matched command/subcommand.

Assert - Class in picocli.codegen.util

Utility class providing some defensive coding convenience methods.

AT_FILE_POSITIONAL_PARAM - Variable in class picocli.CommandLine.Help

atFileCommentChar() - Method in class picocli.CommandLine.Model.ParserSpec

atFileCommentChar(Character) - Method in class picocli.CommandLine.Model.ParserSpec

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

Returns the section of the usage help message that lists the @-file and its description.

AUTO - picocli.CommandLine.Help.Ansi

Only emit ANSI escape codes if the platform supports it and system property "picocli.ansi" is not set to any value other than "true" (case insensitive).

AutoComplete - Class in picocli

Stand-alone tool that generates bash auto-complete scripts for picocli-based command line applications.

AutoComplete.GenerateCompletion - Class in picocli

Command that generates a Bash/ZSH completion script for its top-level command.

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

Returns whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.

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

Sets whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.

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

Returns auxiliary type information used when the CommandLine.Model.ArgSpec.type() is a generic type like Collection, Map or Optional; returns the concrete type when CommandLine.Model.ArgSpec.type() is an abstract class, otherwise, returns the same as CommandLine.Model.ArgSpec.type().

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