A B C D E F G H I J L M N O P Q R S T U V W Y
All Classes All Packages

A

addConfig(String) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Adds a configuration file to the builder.

addConfigIfExists(String) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Adds a configuration file to the builder only if it exists.

addExtraArgs(String...) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Adds extra arguments to the CLI arguments before positional arguments.

addReceiver(T) - Method in class software.amazon.smithy.cli.Arguments

Adds an argument receiver to the argument list.

addSourcesIfExists(Collection<String>) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Adds a collection of "source" model files only if they exist.

ALLOW_UNKNOWN_TRAITS - Static variable in class software.amazon.smithy.cli.commands.BuildOptions

allowUnknownTraits() - Method in class software.amazon.smithy.cli.commands.BuildOptions

allowUnknownTraits(boolean) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Ignores unknown traits when building models.

args - Variable in class software.amazon.smithy.cli.BuildParameterBuilder.Result

Smithy Build command line arguments.

ArgumentReceiver - Interface in software.amazon.smithy.cli

A command line argument receiver.

Arguments - Class in software.amazon.smithy.cli

Command line arguments list to evaluate.

Arguments(String[]) - Constructor for class software.amazon.smithy.cli.Arguments

AstCommand - Class in software.amazon.smithy.cli.commands

AstCommand(String) - Constructor for class software.amazon.smithy.cli.commands.AstCommand

B

BG_BLACK - Static variable in interface software.amazon.smithy.cli.Style

BG_BLUE - Static variable in interface software.amazon.smithy.cli.Style

BG_BRIGHT_BLACK - Static variable in interface software.amazon.smithy.cli.Style

BG_BRIGHT_BLUE - Static variable in interface software.amazon.smithy.cli.Style

BG_BRIGHT_CYAN - Static variable in interface software.amazon.smithy.cli.Style

BG_BRIGHT_GREEN - Static variable in interface software.amazon.smithy.cli.Style

BG_BRIGHT_MAGENTA - Static variable in interface software.amazon.smithy.cli.Style

BG_BRIGHT_RED - Static variable in interface software.amazon.smithy.cli.Style

BG_BRIGHT_WHITE - Static variable in interface software.amazon.smithy.cli.Style

BG_BRIGHT_YELLOW - Static variable in interface software.amazon.smithy.cli.Style

BG_CYAN - Static variable in interface software.amazon.smithy.cli.Style

BG_GREEN - Static variable in interface software.amazon.smithy.cli.Style

BG_MAGENTA - Static variable in interface software.amazon.smithy.cli.Style

BG_RED - Static variable in interface software.amazon.smithy.cli.Style

BG_WHITE - Static variable in interface software.amazon.smithy.cli.Style

BG_YELLOW - Static variable in interface software.amazon.smithy.cli.Style

BLACK - Static variable in interface software.amazon.smithy.cli.Style

BLUE - Static variable in interface software.amazon.smithy.cli.Style

BOLD - Static variable in interface software.amazon.smithy.cli.Style

BRIGHT_BLACK - Static variable in interface software.amazon.smithy.cli.Style

BRIGHT_BLUE - Static variable in interface software.amazon.smithy.cli.Style

BRIGHT_CYAN - Static variable in interface software.amazon.smithy.cli.Style

BRIGHT_GREEN - Static variable in interface software.amazon.smithy.cli.Style

BRIGHT_MAGENTA - Static variable in interface software.amazon.smithy.cli.Style

BRIGHT_RED - Static variable in interface software.amazon.smithy.cli.Style

BRIGHT_WHITE - Static variable in interface software.amazon.smithy.cli.Style

BRIGHT_YELLOW - Static variable in interface software.amazon.smithy.cli.Style

build() - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Computes the result object that is used when running smithy build.

buildClasspath(String) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Sets the build classpath.

BuildCommand - Class in software.amazon.smithy.cli.commands

BuildCommand(String) - Constructor for class software.amazon.smithy.cli.commands.BuildCommand

BuildOptions - Class in software.amazon.smithy.cli.commands

Arguments available to commands that load and build models.

BuildOptions() - Constructor for class software.amazon.smithy.cli.commands.BuildOptions

BuildParameterBuilder - Class in software.amazon.smithy.cli

This builder can be used to build up a Smithy CLI command to run `smithy build`.

BuildParameterBuilder() - Constructor for class software.amazon.smithy.cli.BuildParameterBuilder

BuildParameterBuilder.ClassPathTagMatcher - Interface in software.amazon.smithy.cli

Interface used to query a classpath for the given projection sources tags.

BuildParameterBuilder.JarFileClassPathTagMatcher - Class in software.amazon.smithy.cli

Finds JARs by opening each JAR in the classpath and looking for "Smithy-Tags" in the META-INF/MANIFEST.MF file.

BuildParameterBuilder.Result - Class in software.amazon.smithy.cli

Result class used to build source and projection JARs.

C

classLoader() - Method in class software.amazon.smithy.cli.Command.Env

classLoader(ClassLoader) - Method in class software.amazon.smithy.cli.SmithyCli

Sets a custom class loader to use when executing commands.

classpath - Variable in class software.amazon.smithy.cli.BuildParameterBuilder.Result

Smithy build classpath string.

Cli - Class in software.amazon.smithy.cli

This class provides a very basic CLI abstraction.

Cli(Command, ClassLoader) - Constructor for class software.amazon.smithy.cli.Cli

Creates a new CLI with the given name.

CliError - Exception in software.amazon.smithy.cli

Throw this exception to cause the CLI to exit with a message and code.

CliError(String) - Constructor for exception software.amazon.smithy.cli.CliError

Exits the CLI with a message and an error code of 1.

CliError(String, int) - Constructor for exception software.amazon.smithy.cli.CliError

CliError(String, int, Throwable) - Constructor for exception software.amazon.smithy.cli.CliError

CliPrinter - Interface in software.amazon.smithy.cli

Handles text output of the CLI.

CliPrinter.ConsumerPrinter - Class in software.amazon.smithy.cli

CliPrinter that calls a Consumer that accepts a CharSequence.

code - Variable in exception software.amazon.smithy.cli.CliError

Command - Interface in software.amazon.smithy.cli

Represents a CLI command.

Command.Env - Class in software.amazon.smithy.cli

Environment settings for the command.

ConsumerPrinter(Consumer<CharSequence>) - Constructor for class software.amazon.smithy.cli.CliPrinter.ConsumerPrinter

create() - Static method in class software.amazon.smithy.cli.SmithyCli

Creates a new instance of the CLI.

createArgumentReceivers() - Method in class software.amazon.smithy.cli.commands.AstCommand

createArgumentReceivers() - Method in class software.amazon.smithy.cli.commands.BuildCommand

createArgumentReceivers() - Method in class software.amazon.smithy.cli.commands.DiffCommand

createArgumentReceivers() - Method in class software.amazon.smithy.cli.commands.SelectCommand

createArgumentReceivers() - Method in class software.amazon.smithy.cli.commands.Upgrade1to2Command

createArgumentReceivers() - Method in class software.amazon.smithy.cli.commands.ValidateCommand

createCli() - Method in class software.amazon.smithy.cli.SmithyCli

Creates a runnable CLI.

CYAN - Static variable in interface software.amazon.smithy.cli.Style

D

debug() - Method in class software.amazon.smithy.cli.StandardOptions

DEBUG - Static variable in class software.amazon.smithy.cli.StandardOptions

DiffCommand - Class in software.amazon.smithy.cli.commands

DiffCommand(String) - Constructor for class software.amazon.smithy.cli.commands.DiffCommand

discover() - Method in class software.amazon.smithy.cli.commands.BuildOptions

discover(boolean) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Enables model discovery.

DISCOVER - Static variable in class software.amazon.smithy.cli.commands.BuildOptions

DISCOVER_CLASSPATH - Static variable in class software.amazon.smithy.cli.commands.BuildOptions

DISCOVER_SHORT - Static variable in class software.amazon.smithy.cli.commands.BuildOptions

discoverClasspath() - Method in class software.amazon.smithy.cli.commands.BuildOptions

discoveryClasspath - Variable in class software.amazon.smithy.cli.BuildParameterBuilder.Result

Smithy build discovery classpath string.

documentation(String) - Method in class software.amazon.smithy.cli.HelpPrinter

Defines the optional long-form documentation that comes after long argument descriptions.

E

Env(CliPrinter, CliPrinter, ClassLoader) - Constructor for class software.amazon.smithy.cli.Command.Env

execute(Arguments, Command.Env) - Method in interface software.amazon.smithy.cli.Command

Executes the command using the provided arguments.

execute(Arguments, Command.Env) - Method in class software.amazon.smithy.cli.commands.SmithyCommand

F

FAINT - Static variable in interface software.amazon.smithy.cli.Style

findJarsWithMatchingTags(Set<String>, Set<String>) - Method in interface software.amazon.smithy.cli.BuildParameterBuilder.ClassPathTagMatcher

Finds all JARs that contain any of the given set of tags.

findJarsWithMatchingTags(Set<String>, Set<String>) - Method in class software.amazon.smithy.cli.BuildParameterBuilder.JarFileClassPathTagMatcher

finishParsing() - Method in class software.amazon.smithy.cli.Arguments

Expects that all remaining arguments are positional, and returns them.

FORCE_COLOR - Static variable in class software.amazon.smithy.cli.StandardOptions

forceColor() - Method in class software.amazon.smithy.cli.StandardOptions

format(String, Style...) - Static method in interface software.amazon.smithy.cli.Style

Formats the given text with ANSI escapes.

fromArguments(String, Arguments) - Static method in class software.amazon.smithy.cli.HelpPrinter

Create a HelpPrinter that registers help options and parameters defined in the given arguments.

G

getDocumentation(CliPrinter) - Method in interface software.amazon.smithy.cli.Command

Gets the long description of the command.

getDocumentation(CliPrinter) - Method in class software.amazon.smithy.cli.commands.SelectCommand

getName() - Method in interface software.amazon.smithy.cli.Command

Gets the name of the command.

getName() - Method in class software.amazon.smithy.cli.commands.AstCommand

getName() - Method in class software.amazon.smithy.cli.commands.BuildCommand

getName() - Method in class software.amazon.smithy.cli.commands.DiffCommand

getName() - Method in class software.amazon.smithy.cli.commands.SelectCommand

getName() - Method in class software.amazon.smithy.cli.commands.SmithyCommand

getName() - Method in class software.amazon.smithy.cli.commands.Upgrade1to2Command

getName() - Method in class software.amazon.smithy.cli.commands.ValidateCommand

getReceiver(Class<T>) - Method in class software.amazon.smithy.cli.Arguments

Get a receiver by class.

getReceivers() - Method in class software.amazon.smithy.cli.Arguments

Get the argument receivers registered with the Arguments list.

getSummary() - Method in interface software.amazon.smithy.cli.Command

Gets a short summary of the command that's shown in the main help.

getSummary() - Method in class software.amazon.smithy.cli.commands.AstCommand

getSummary() - Method in class software.amazon.smithy.cli.commands.BuildCommand

getSummary() - Method in class software.amazon.smithy.cli.commands.DiffCommand

getSummary() - Method in class software.amazon.smithy.cli.commands.SelectCommand

getSummary() - Method in class software.amazon.smithy.cli.commands.SmithyCommand

getSummary() - Method in class software.amazon.smithy.cli.commands.Upgrade1to2Command

getSummary() - Method in class software.amazon.smithy.cli.commands.ValidateCommand

GREEN - Static variable in interface software.amazon.smithy.cli.Style

H

hasNext() - Method in class software.amazon.smithy.cli.Arguments

Checks if any arguments are remaining.

help() - Method in class software.amazon.smithy.cli.StandardOptions

HELP - Static variable in class software.amazon.smithy.cli.StandardOptions

HELP_SHORT - Static variable in class software.amazon.smithy.cli.StandardOptions

HelpPrinter - Class in software.amazon.smithy.cli

Generates and prints structured help output to a CliPrinter.

HelpPrinter(String) - Constructor for class software.amazon.smithy.cli.HelpPrinter

I

ITALIC - Static variable in interface software.amazon.smithy.cli.Style

J

JarFileClassPathTagMatcher() - Constructor for class software.amazon.smithy.cli.BuildParameterBuilder.JarFileClassPathTagMatcher

L

libClasspath(String) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Sets the lib classpath.

logging() - Method in class software.amazon.smithy.cli.StandardOptions

LOGGING - Static variable in class software.amazon.smithy.cli.StandardOptions

M

MAGENTA - Static variable in interface software.amazon.smithy.cli.Style

main(String...) - Static method in class software.amazon.smithy.cli.SmithyCli

Executes the CLI.

maxWidth(int) - Method in class software.amazon.smithy.cli.HelpPrinter

MODELS - Static variable in class software.amazon.smithy.cli.commands.BuildOptions

N

NO_COLOR - Static variable in class software.amazon.smithy.cli.StandardOptions

noColor() - Method in class software.amazon.smithy.cli.StandardOptions

O

onComplete(BiConsumer<Arguments, List<String>>) - Method in class software.amazon.smithy.cli.Arguments

Adds a subscriber to the arguments that is invoked when arguments have finished parsing.

option(String, String, String) - Method in class software.amazon.smithy.cli.HelpPrinter

Adds an option that takes no argument value.

output(String) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Sets the optional output directory.

P

param(String, String, String, String) - Method in class software.amazon.smithy.cli.HelpPrinter

Adds a parameter that requires an argument value.

peek() - Method in class software.amazon.smithy.cli.Arguments

Peeks at the next value in the arguments list without shifting it.

plugin(String) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Ensures that only the given plugin is built in each projection.

positional(String, String) - Method in class software.amazon.smithy.cli.HelpPrinter

Defines a positional argument.

print(CliPrinter) - Method in class software.amazon.smithy.cli.HelpPrinter

Prints the generated help to the given printer.

printHelp(Arguments, CliPrinter) - Method in interface software.amazon.smithy.cli.Command

Prints help output.

printHelp(Arguments, CliPrinter) - Method in class software.amazon.smithy.cli.commands.SmithyCommand

println(String) - Method in class software.amazon.smithy.cli.CliPrinter.ConsumerPrinter

println(String) - Method in interface software.amazon.smithy.cli.CliPrinter

Prints text to the writer and appends a new line.

projection(String) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Ensures that only the given projection is built.

projectionSource(String) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Sets the name of the projection being built as a source.

projectionSourceTags(String) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Sets the tags to find in the build classpath when projecting a JAR.

projectionSourceTags(Collection<String>) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Sets the tags to find in the build classpath when projecting a JAR.

pushCodes(IntConsumer) - Method in interface software.amazon.smithy.cli.Style

Pushes one or more ANSI color codes to the consumer.

pushCodes(IntConsumer) - Method in class software.amazon.smithy.cli.Style.SingularCode

Q

quiet() - Method in class software.amazon.smithy.cli.StandardOptions

QUIET - Static variable in class software.amazon.smithy.cli.StandardOptions

R

RED - Static variable in interface software.amazon.smithy.cli.Style

registerHelp(HelpPrinter) - Method in interface software.amazon.smithy.cli.ArgumentReceiver

Registers help information to the given HelpPrinter.

registerHelp(HelpPrinter) - Method in class software.amazon.smithy.cli.commands.BuildOptions

registerHelp(HelpPrinter) - Method in class software.amazon.smithy.cli.StandardOptions

run(String[]) - Method in class software.amazon.smithy.cli.Cli

Execute the command line using the given arguments.

run(String...) - Method in class software.amazon.smithy.cli.SmithyCli

Runs the CLI.

run(List<String>) - Method in class software.amazon.smithy.cli.SmithyCli

Runs the CLI using a list of arguments.

run(Arguments, Command.Env, List<String>) - Method in class software.amazon.smithy.cli.commands.AstCommand

run(Arguments, Command.Env, List<String>) - Method in class software.amazon.smithy.cli.commands.BuildCommand

run(Arguments, Command.Env, List<String>) - Method in class software.amazon.smithy.cli.commands.DiffCommand

run(Arguments, Command.Env, List<String>) - Method in class software.amazon.smithy.cli.commands.SelectCommand

run(Arguments, Command.Env, List<String>) - Method in class software.amazon.smithy.cli.commands.Upgrade1to2Command

run(Arguments, Command.Env, List<String>) - Method in class software.amazon.smithy.cli.commands.ValidateCommand

S

SelectCommand - Class in software.amazon.smithy.cli.commands

SelectCommand(String) - Constructor for class software.amazon.smithy.cli.commands.SelectCommand

severity() - Method in class software.amazon.smithy.cli.StandardOptions

SEVERITY - Static variable in class software.amazon.smithy.cli.StandardOptions

shift() - Method in class software.amazon.smithy.cli.Arguments

Shifts off the next value in the arguments list or returns null.

shiftFor(String) - Method in class software.amazon.smithy.cli.Arguments

Expects an argument value for a parameter by name.

SingularCode(int) - Constructor for class software.amazon.smithy.cli.Style.SingularCode

SmithyCli - Class in software.amazon.smithy.cli

Entry point of the Smithy CLI.

SmithyCommand - Class in software.amazon.smithy.cli.commands

SmithyCommand() - Constructor for class software.amazon.smithy.cli.commands.SmithyCommand

software.amazon.smithy.cli - package software.amazon.smithy.cli

software.amazon.smithy.cli.commands - package software.amazon.smithy.cli.commands

sources - Variable in class software.amazon.smithy.cli.BuildParameterBuilder.Result

The set of source models, including computed sources used in the argument list.

sources(Collection<String>) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Adds a collection of "source" model files.

stackTrace() - Method in class software.amazon.smithy.cli.StandardOptions

STACKTRACE - Static variable in class software.amazon.smithy.cli.StandardOptions

StandardOptions - Class in software.amazon.smithy.cli

Options available to all commands.

StandardOptions() - Constructor for class software.amazon.smithy.cli.StandardOptions

stderr() - Method in class software.amazon.smithy.cli.Command.Env

stderr(CliPrinter) - Method in class software.amazon.smithy.cli.Cli

stdout() - Method in class software.amazon.smithy.cli.Command.Env

stdout(CliPrinter) - Method in class software.amazon.smithy.cli.Cli

style(String, Style...) - Method in interface software.amazon.smithy.cli.CliPrinter

Styles the given text using ANSI escape sequences.

Style - Interface in software.amazon.smithy.cli

Parameters used to change the ANSI public style of text.

Style.SingularCode - Class in software.amazon.smithy.cli

A simple implementation of Style that pushes a single code.

summary(String) - Method in class software.amazon.smithy.cli.HelpPrinter

Defines the summary text of the command that comes after the short argument description and before the long argument descriptions.

T

tagMatcher(BuildParameterBuilder.ClassPathTagMatcher) - Method in class software.amazon.smithy.cli.BuildParameterBuilder

Sets the implementation used to find JARs with the given tags.

testOption(String) - Method in interface software.amazon.smithy.cli.ArgumentReceiver

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

testOption(String) - Method in class software.amazon.smithy.cli.commands.BuildOptions

testOption(String) - Method in class software.amazon.smithy.cli.StandardOptions

testParameter(String) - Method in interface software.amazon.smithy.cli.ArgumentReceiver

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

testParameter(String) - Method in class software.amazon.smithy.cli.commands.BuildOptions

testParameter(String) - Method in class software.amazon.smithy.cli.StandardOptions

U

UNDERLINE - Static variable in interface software.amazon.smithy.cli.Style

Upgrade1to2Command - Class in software.amazon.smithy.cli.commands

Upgrade1to2Command(String) - Constructor for class software.amazon.smithy.cli.commands.Upgrade1to2Command

V

ValidateCommand - Class in software.amazon.smithy.cli.commands

ValidateCommand(String) - Constructor for class software.amazon.smithy.cli.commands.ValidateCommand

W

WHITE - Static variable in interface software.amazon.smithy.cli.Style

wrap(Throwable) - Static method in exception software.amazon.smithy.cli.CliError

Wraps the given exception in a CliError (no wrapping is performed if the given exception is an instance of CliError).

Y

YELLOW - Static variable in interface software.amazon.smithy.cli.Style

A B C D E F G H I J L M N O P Q R S T U V W Y
All Classes All Packages