A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

acceptLongOptionsWithSingleHyphen - Property in CliBuilder

For backwards compatibility with Apache Commons CLI, set this property to true if the parser should recognize long options with both a single hyphen and a double hyphen prefix.

arguments() - Method in OptionAccessor

B

C

CliBuilder - Class in groovy.cli.picocli

Provides a builder to assist the processing of command line arguments.

CliBuilder() - Constructor in CliBuilder

D

defaultValue(java.lang.String) - Method in OptionAccessor

E

errorWriter - Property in CliBuilder

The PrintWriter to write to when invalid user input was provided to the parse(java.lang.String[]) method.

expandArgumentFiles - Property in CliBuilder

Whether arguments of the form '@filename' will be expanded into the arguments contained within the file named filename (default true).

F

footer - Property in CliBuilder

Optional additional message for usage; displayed after the options.

G

getAt(TypedOption<T>, T) - Method in OptionAccessor

getOptionProperties(java.lang.String) - Method in OptionAccessor

getOptionValue(TypedOption<T>, T) - Method in OptionAccessor

getProperty(java.lang.String) - Method in OptionAccessor

H

hasOption(groovy.cli.TypedOption) - Method in OptionAccessor

header - Property in CliBuilder

Optional additional message for usage; displayed after the usage summary but before the options are displayed.

I

invokeMethod(java.lang.String, java.lang.Object) - Method in CliBuilder

Internal method: Detect option specification method calls.

invokeMethod(java.lang.String, java.lang.Object) - Method in OptionAccessor

J

K

L

M

N

name - Property in CliBuilder

This property allows customizing the program name displayed in the synopsis when cli.usage() is called.

O

option(java.lang.Object, java.util.Map, java.lang.Object) - Method in CliBuilder

Internal method: How to create an OptionSpec from the specification.

OptionAccessor - Class in groovy.cli.picocli

OptionAccessor(picocli.CommandLine$ParseResult) - Constructor in OptionAccessor

P

parse(java.lang.Object) - Method in CliBuilder

Make options accessible from command line args with parser.

parseFromInstance(T, java.lang.Object) - Method in CliBuilder

Given an instance containing members with annotations, derive the options specification.

parseFromSpec(Class<T>, java.lang.String) - Method in CliBuilder

Given an interface containing members with annotations, derive the options specification.

parser - Property in CliBuilder

parseResult - Property in OptionAccessor

posix - Property in CliBuilder

To disallow clustered POSIX short options, set this to false.

Q

R

S

savedTypeOptions - Property in CliBuilder

Internal data structure mapping option names to their associated groovy.cli.TypedOption object.

savedTypeOptions - Property in OptionAccessor

setExpandArgumentFiles(boolean) - Method in CliBuilder

Sets the expandArgumentFiles property on this CliBuilder and on the parser used by the underlying library.

setFooter(java.lang.String) - Method in CliBuilder

Sets the footer property on this CliBuilder and on the usageMessage used by the underlying library.

setHeader(java.lang.String) - Method in CliBuilder

Sets the header property on this CliBuilder and the description on the usageMessage used by the underlying library.

setPosix(java.lang.Boolean) - Method in CliBuilder

Sets the posix property on this CliBuilder and the posixClusteredShortOptionsAllowed property on the parser used by the underlying library.

setStopAtNonOption(boolean) - Method in CliBuilder

Sets the stopAtNonOption property on this CliBuilder and the stopAtPositional property on the parser used by the underlying library.

setUsage(java.lang.String) - Method in CliBuilder

Sets the usage property on this CliBuilder and the customSynopsis on the usageMessage used by the underlying library.

setWidth(int) - Method in CliBuilder

Sets the width property on this CliBuilder and on the usageMessage used by the underlying library.

setWriter(java.io.PrintWriter) - Method in CliBuilder

For backwards compatibility reasons, if a custom writer is set, this sets both the writer and the errorWriter to the specified writer.

stopAtNonOption - Property in CliBuilder

Configures what the parser should do when arguments not recognized as options are encountered: when true (the default), the remaining arguments are all treated as positional parameters.

T

U

usage - Property in CliBuilder

The command synopsis displayed as the first line in the usage help message, e.g., when cli.usage() is called.

usageMessage - Property in CliBuilder

V

W

width - Property in CliBuilder

Allows customisation of the usage message width.

writer - Property in CliBuilder

The PrintWriter to write the usage help message to when cli.usage() is called.

X

Y

Z

_