Package software.amazon.smithy.cli.commands

Class BuildOptions

java.lang.Object

software.amazon.smithy.cli.commands.BuildOptions

All Implemented Interfaces:

ArgumentReceiver

public final class BuildOptions
extends Object
implements ArgumentReceiver

Arguments available to commands that load and build models.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_UNKNOWN_TRAITS
static final String	DISCOVER
static final String	DISCOVER_CLASSPATH
static final String	DISCOVER_SHORT
static final String	MODELS

Constructor Summary

Constructors

Constructor	Description
BuildOptions()

Method Summary

Modifier and Type	Method	Description
boolean	allowUnknownTraits()
boolean	discover()
String	discoverClasspath()
void	registerHelp(HelpPrinter printer)	Registers help information to the given HelpPrinter.
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

ALLOW_UNKNOWN_TRAITS

public static final String ALLOW_UNKNOWN_TRAITS

See Also:

• Constant Field Values

DISCOVER

public static final String DISCOVER

See Also:

• Constant Field Values

DISCOVER_SHORT

public static final String DISCOVER_SHORT

See Also:

• Constant Field Values

DISCOVER_CLASSPATH

public static final String DISCOVER_CLASSPATH

See Also:

• Constant Field Values

MODELS

public static final String MODELS

See Also:

• Constant Field Values

Constructor Details

BuildOptions

public BuildOptions()

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 not accepted.

discoverClasspath

public String discoverClasspath()

allowUnknownTraits

public boolean allowUnknownTraits()

discover

public boolean discover()