org.gradle.cli

Class CommandLineParser

java.lang.Object

org.gradle.cli.CommandLineParser

public class CommandLineParser
extends Object

A command-line parser which supports a command/sub-command style command-line interface. Supports the following syntax:

 <option>* (<sub-command> <sub-command-option>*)*
 

• Short options are a '-' followed by a single character. For example: -a.
• Long options are '--' followed by multiple characters. For example: --long-option.
• Options can take arguments. The argument follows the option. For example: -a arg or --long arg.
• Arguments can be attached to the option using '='. For example: -a=arg or --long=arg.
• Arguments can be attached to short options. For example: -aarg.
• Short options can be combined. For example -ab is equivalent to -a -b.
• Anything else is treated as an extra argument. This includes a single - character.
• '--' indicates the end of the options. Anything following is not parsed and is treated as extra arguments.
• The parser is forgiving, and allows '--' to be used with short options and '-' to be used with long options.
• The set of options must be known at parse time. Sub-commands and their options do not need to be known at parse time. Use ParsedCommandLine.getExtraArguments() to obtain the non-option command-line arguments.

Constructor Summary

Constructors

Constructor and Description
CommandLineParser()
CommandLineParser(Writer deprecationPrinter)

Method Summary

Methods

Modifier and Type	Method and Description
CommandLineParser	allowMixedSubcommandsAndOptions()
CommandLineParser	allowUnknownOptions()
CommandLineOption	option(String... options) Defines a new option.
ParsedCommandLine	parse(Iterable<String> commandLine) Parses the given command-line.
ParsedCommandLine	parse(String... commandLine) Parses the given command-line.
void	printUsage(Appendable out) Prints a usage message to the given stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommandLineParser

public CommandLineParser()

CommandLineParser

public CommandLineParser(Writer deprecationPrinter)

Method Detail

parse

public ParsedCommandLine parse(String... commandLine)
                        throws CommandLineArgumentException

Parses the given command-line.

Parameters:

commandLine - The command-line.

Returns:

The parsed command line.

Throws:

CommandLineArgumentException - On parse failure.

parse

public ParsedCommandLine parse(Iterable<String> commandLine)
                        throws CommandLineArgumentException

Parses the given command-line.

Parameters:

commandLine - The command-line.

Returns:

The parsed command line.

Throws:

CommandLineArgumentException - On parse failure.

allowMixedSubcommandsAndOptions

public CommandLineParser allowMixedSubcommandsAndOptions()

allowUnknownOptions

public CommandLineParser allowUnknownOptions()

printUsage

public void printUsage(Appendable out)

Prints a usage message to the given stream.

Parameters:

out - The output stream to write to.

option

public CommandLineOption option(String... options)

Defines a new option. By default, the option takes no arguments and has no description.

Parameters:

options - The options values.

Returns:

The option, which can be further configured.