Package software.amazon.smithy.cli

Class Parser

java.lang.Object

software.amazon.smithy.cli.Parser

public final class Parser
extends Object

Defines the CLI argument parser of a Command.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Parser.Argument	A command line argument.
static enum	Parser.Arity	Defines the arity of an argument.
static final class	Parser.Builder	Builds an Parser.

Method Summary

Modifier and Type	Method	Description
static Parser.Builder	builder()
List<Parser.Argument>	getArgs()
Optional<String>	getPositionalHelp()
Optional<String>	getPositionalName()
Arguments	parse(String[] args)	Parses command line arguments in an Arguments object.
Arguments	parse(String[] args, int offset)	Parses command line arguments in an Arguments object.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static Parser.Builder builder()

getPositionalName

public Optional<String> getPositionalName()

getPositionalHelp

public Optional<String> getPositionalHelp()

getArgs

public List<Parser.Argument> getArgs()

parse

public Arguments parse(String[] args)

Parses command line arguments in an Arguments object.

All arguments after the first argument that does not start with "-" or after "--" are treated as positional options. Arguments that come before this must be present in the argument spec returned by the command. Any encountered unknown argument will throw an exception. Arguments that expect a value and do not find one will throw an exception.

Parameters:

args - Arguments to parse.

Returns:

Returns the parsed arguments.

Throws:

CliError - if the arguments are invalid.

parse

public Arguments parse(String[] args,
 int offset)

Parses command line arguments in an Arguments object.

Parameters:

args - Arguments to parse.

offset - Number of arguments to skip before parsing.

Returns:

Returns the parsed arguments.

Throws:

CliError - if the arguments are invalid.

See Also:

• parse(String[])