Package software.amazon.smithy.cli

Class StandardOptions

java.lang.Object

software.amazon.smithy.cli.StandardOptions

All Implemented Interfaces:

ArgumentReceiver

public final class StandardOptions
extends Object
implements ArgumentReceiver

Options available to all commands.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEBUG
static final String	FORCE_COLOR
static final String	HELP
static final String	HELP_SHORT
static final String	LOGGING
static final String	NO_COLOR
static final String	QUIET
static final String	STACKTRACE

Constructor Summary

Constructors

Constructor	Description
StandardOptions()

Method Summary

Modifier and Type	Method	Description
AnsiColorFormatter	colorSetting()
boolean	debug()
boolean	help()
Level	logging()
boolean	quiet()
void	registerHelp(HelpPrinter printer)	Registers help information to the given HelpPrinter.
boolean	stackTrace()
boolean	testOption(String name)	Test if the given value-less option is accepted by the receiver.
Consumer<String>	testParameter(String name)	Test if the given parameter that requires a value is accepted by the receiver.

Methods inherited from class java.lang.Object

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

Field Details

HELP_SHORT

public static final String HELP_SHORT

See Also:

• Constant Field Values

HELP

public static final String HELP

See Also:

• Constant Field Values

DEBUG

public static final String DEBUG

See Also:

• Constant Field Values

QUIET

public static final String QUIET

See Also:

• Constant Field Values

STACKTRACE

public static final String STACKTRACE

See Also:

• Constant Field Values

NO_COLOR

public static final String NO_COLOR

See Also:

• Constant Field Values

FORCE_COLOR

public static final String FORCE_COLOR

See Also:

• Constant Field Values

LOGGING

public static final String LOGGING

See Also:

• Constant Field Values

Constructor Details

StandardOptions

public StandardOptions()

Method Details

registerHelp

public void registerHelp(HelpPrinter printer)

Description copied from interface: ArgumentReceiver

Registers help information to the given HelpPrinter.

Specified by:

registerHelp in interface ArgumentReceiver

Parameters:

printer - Printer to modify.

testOption

public boolean testOption(String name)

Description copied from interface: ArgumentReceiver

Test if the given value-less option is accepted by the receiver.

If the option is accepted, the receiver should store a stateful value to indicate the option was received, and the CLI will skip the argument for further processing.

Specified by:

testOption in interface ArgumentReceiver

Parameters:

name - Name of the option to test.

Returns:

Returns true if accepted.

testParameter

public Consumer<String> testParameter(String name)

Description copied from interface: ArgumentReceiver

Test if the given parameter that requires a value is accepted by the receiver.

If the parameter is accepted, the receiver returns a Consumer that receives the expected value, and it should store a stateful value to allow the value to be later recalled. The CLI will skip the argument for further processing.

Specified by:

testParameter in interface ArgumentReceiver

Parameters:

name - Name of the parameter to test.

Returns:

Returns a consumer if accepted or null if rejected.

help

public boolean help()

logging

public Level logging()

quiet

public boolean quiet()

debug

public boolean debug()

stackTrace

public boolean stackTrace()

colorSetting

public AnsiColorFormatter colorSetting()