Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
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.
- addDependency(String) - Method in interface software.amazon.smithy.cli.dependencies.DependencyResolver
-
Add a dependency.
- addDependency(String) - Method in class software.amazon.smithy.cli.dependencies.FileCacheResolver
- addDependency(String) - Method in class software.amazon.smithy.cli.dependencies.FilterCliVersionResolver
- addDependency(String) - Method in class software.amazon.smithy.cli.dependencies.MavenDependencyResolver
- addExtraArgs(String...) - Method in class software.amazon.smithy.cli.BuildParameterBuilder
-
Adds extra arguments to the CLI arguments before positional arguments.
- addReceiver(ArgumentReceiver) - Method in interface software.amazon.smithy.cli.Arguments
-
Adds an argument receiver to the argument list.
- addRepository(MavenRepository) - Method in interface software.amazon.smithy.cli.dependencies.DependencyResolver
-
Add a Maven repository.
- addRepository(MavenRepository) - Method in class software.amazon.smithy.cli.dependencies.FileCacheResolver
- addRepository(MavenRepository) - Method in class software.amazon.smithy.cli.dependencies.FilterCliVersionResolver
- addRepository(MavenRepository) - Method in class software.amazon.smithy.cli.dependencies.MavenDependencyResolver
- addSourcesIfExists(Collection<String>) - Method in class software.amazon.smithy.cli.BuildParameterBuilder
-
Adds a collection of "source" model files only if they exist.
- allowUnknownTraits(boolean) - Method in class software.amazon.smithy.cli.BuildParameterBuilder
-
Ignores unknown traits when building models.
- AnsiColorFormatter - Enum Class in software.amazon.smithy.cli
-
Styles text using ANSI color codes.
- append(char) - Method in interface software.amazon.smithy.cli.CliPrinter
- append(char) - Method in class software.amazon.smithy.cli.ColorBuffer
- append(CharSequence) - Method in interface software.amazon.smithy.cli.CliPrinter
- append(CharSequence) - Method in class software.amazon.smithy.cli.ColorBuffer
- append(CharSequence, int, int) - Method in interface software.amazon.smithy.cli.CliPrinter
- append(CharSequence, int, int) - Method in class software.amazon.smithy.cli.ColorBuffer
- 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 - Interface in software.amazon.smithy.cli
-
Command line arguments list to evaluate.
- AUTO - Enum constant in enum class software.amazon.smithy.cli.AnsiColorFormatter
-
Writes using ANSI colors if it detects that the environment supports color.
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.
- 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.
- clear() - Method in enum class software.amazon.smithy.cli.EnvironmentVariable
-
Clears the system property for the variable.
- Cli - Class in software.amazon.smithy.cli
-
This class provides a 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.
- close() - Method in class software.amazon.smithy.cli.ColorBuffer
- code - Variable in exception software.amazon.smithy.cli.CliError
- ColorBuffer - Class in software.amazon.smithy.cli
-
An
Appendablethat supports color provided by aColorFormatter. - colorFormatter(ColorFormatter) - Method in class software.amazon.smithy.cli.Cli
- ColorFormatter - Interface in software.amazon.smithy.cli
-
Styles text using color codes.
- colors() - Method in class software.amazon.smithy.cli.Command.Env
- colorSetting() - Method in class software.amazon.smithy.cli.StandardOptions
- ColorTheme - Class in software.amazon.smithy.cli
-
Standardizes on colors across commands.
- Command - Interface in software.amazon.smithy.cli
-
Represents a CLI command.
- Command.Env - Class in software.amazon.smithy.cli
-
Environment settings for the command.
- Constant(String) - Constructor for class software.amazon.smithy.cli.Style.Constant
- create() - Static method in class software.amazon.smithy.cli.SmithyCli
-
Creates a new instance of the CLI.
- create(SmithyBuildConfig, Command.Env) - Method in interface software.amazon.smithy.cli.dependencies.DependencyResolver.Factory
-
Creates a
DependencyResolver. - createCli() - Method in class software.amazon.smithy.cli.SmithyCli
-
Creates a runnable CLI.
- CYAN - Static variable in interface software.amazon.smithy.cli.Style
D
- DANGER - Static variable in class software.amazon.smithy.cli.ColorTheme
- DANGER_TITLE - Static variable in class software.amazon.smithy.cli.ColorTheme
- debug() - Method in class software.amazon.smithy.cli.StandardOptions
- DEBUG - Static variable in class software.amazon.smithy.cli.StandardOptions
- DependencyResolver - Interface in software.amazon.smithy.cli.dependencies
-
Resolves Maven dependencies for the Smithy CLI.
- DependencyResolver.Factory - Interface in software.amazon.smithy.cli.dependencies
-
Responsible for creating a
DependencyResolverfor the CLI, optionally based on configuration. - DependencyResolverException - Exception in software.amazon.smithy.cli.dependencies
-
Exception encountered while attempting to resolve dependencies.
- DependencyResolverException(String) - Constructor for exception software.amazon.smithy.cli.dependencies.DependencyResolverException
- DependencyResolverException(String, Throwable) - Constructor for exception software.amazon.smithy.cli.dependencies.DependencyResolverException
- DependencyResolverException(Throwable) - Constructor for exception software.amazon.smithy.cli.dependencies.DependencyResolverException
- dependencyResolverFactory(DependencyResolver.Factory) - Method in class software.amazon.smithy.cli.SmithyCli
-
Sets a custom dependency resolver factory to use when resolving dependencies.
- DEPRECATED - Static variable in class software.amazon.smithy.cli.ColorTheme
- detect() - Static method in enum class software.amazon.smithy.cli.AnsiColorFormatter
-
Detects if ANSI colors are supported and returns the appropriate Ansi enum variant.
- DIFF_EVENT_TITLE - Static variable in class software.amazon.smithy.cli.ColorTheme
- DIFF_TITLE - Static variable in class software.amazon.smithy.cli.ColorTheme
- discover(boolean) - Method in class software.amazon.smithy.cli.BuildParameterBuilder
-
Enables model discovery.
- 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
- EM_UNDERLINE - Static variable in class software.amazon.smithy.cli.ColorTheme
- endStyle(Appendable) - Method in interface software.amazon.smithy.cli.ColorFormatter
- Env(ColorFormatter, CliPrinter, CliPrinter, ClassLoader) - Constructor for class software.amazon.smithy.cli.Command.Env
- EnvironmentVariable - Enum Class in software.amazon.smithy.cli
-
Environment variables used by the Smithy CLI.
- equals(Object) - Method in class software.amazon.smithy.cli.dependencies.ResolvedArtifact
- ERROR - Static variable in class software.amazon.smithy.cli.ColorTheme
- ERROR_TITLE - Static variable in class software.amazon.smithy.cli.ColorTheme
- EVENT_SHAPE_ID - Static variable in class software.amazon.smithy.cli.ColorTheme
- 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
- FileCacheResolver - Class in software.amazon.smithy.cli.dependencies
-
A resolver that loads and caches resolved artifacts to a JSON file if the cache is fresh and resolved artifacts haven't been updated after a given reference point in time.
- FileCacheResolver(File, long, DependencyResolver) - Constructor for class software.amazon.smithy.cli.dependencies.FileCacheResolver
- FilterCliVersionResolver - Class in software.amazon.smithy.cli.dependencies
-
Removes Smithy CLI dependencies that conflict with the JARs used by the CLI.
- FilterCliVersionResolver(String, DependencyResolver) - Constructor for class software.amazon.smithy.cli.dependencies.FilterCliVersionResolver
- 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
- flush() - Method in interface software.amazon.smithy.cli.CliPrinter
-
Flushes any buffers in the printer.
- flush() - Method in class software.amazon.smithy.cli.Command.Env
- FORCE_COLOR - Enum constant in enum class software.amazon.smithy.cli.AnsiColorFormatter
-
Writes with ANSI colors.
- FORCE_COLOR - Enum constant in enum class software.amazon.smithy.cli.EnvironmentVariable
-
If set to any value, force enables the support of ANSI colors in the output.
- FORCE_COLOR - Static variable in class software.amazon.smithy.cli.StandardOptions
- 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. - fromCoordinates(Path, String) - Static method in class software.amazon.smithy.cli.dependencies.ResolvedArtifact
-
Creates a resolved artifact from a file path and Maven coordinates string.
- fromOutputStream(OutputStream) - Static method in interface software.amazon.smithy.cli.CliPrinter
-
Create a new CliPrinter from an OutputStream.
G
- get() - Method in enum class software.amazon.smithy.cli.EnvironmentVariable
-
Gets the system property or the environment variable for the property, in that order.
- getAnsiColorCode() - Method in class software.amazon.smithy.cli.Style.Constant
- getAnsiColorCode() - Method in interface software.amazon.smithy.cli.Style
- getAnsiColorCode() - Method in class software.amazon.smithy.cli.Style.Multi
- getArtifactId() - Method in class software.amazon.smithy.cli.dependencies.ResolvedArtifact
- getByName(String) - Static method in enum class software.amazon.smithy.cli.EnvironmentVariable
-
Gets a system property or environment variable by name, in that order.
- getCoordinates() - Method in class software.amazon.smithy.cli.dependencies.ResolvedArtifact
-
Get the resolved coordinates (e.g., group:artifact:version).
- getGroupId() - Method in class software.amazon.smithy.cli.dependencies.ResolvedArtifact
- getName() - Method in interface software.amazon.smithy.cli.Command
-
Gets the name of the command.
- getName() - Method in class software.amazon.smithy.cli.commands.SmithyCommand
- getPath() - Method in class software.amazon.smithy.cli.dependencies.ResolvedArtifact
-
Get the path to the artifact on disk.
- getPositional() - Method in interface software.amazon.smithy.cli.Arguments
-
Gets the positional arguments.
- getReceiver(Class<T>) - Method in interface software.amazon.smithy.cli.Arguments
-
Get a receiver by class.
- getReceivers() - Method in interface 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.SmithyCommand
- getVersion() - Method in class software.amazon.smithy.cli.dependencies.ResolvedArtifact
- getVersion() - Static method in class software.amazon.smithy.cli.SmithyCli
-
Get the Smithy CLI version of the running CLI.
- GREEN - Static variable in interface software.amazon.smithy.cli.Style
H
- hashCode() - Method in class software.amazon.smithy.cli.dependencies.ResolvedArtifact
- hasNext() - Method in interface software.amazon.smithy.cli.Arguments
-
Checks if any arguments are remaining.
- hasReceiver(Class<? extends ArgumentReceiver>) - Method in interface software.amazon.smithy.cli.Arguments
-
Check if this class contains a receiver.
- 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.
- HelpPrinter(String) - Constructor for class software.amazon.smithy.cli.HelpPrinter
- HINT_TITLE - Static variable in class software.amazon.smithy.cli.ColorTheme
I
- isColorEnabled() - Method in interface software.amazon.smithy.cli.ColorFormatter
- isHidden() - Method in interface software.amazon.smithy.cli.Command
-
Return true to hide this command from help output.
- isSet() - Method in enum class software.amazon.smithy.cli.EnvironmentVariable
-
Returns true if the system property or environment variables is set.
- 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.
- LITERAL - Static variable in class software.amazon.smithy.cli.ColorTheme
- 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.
- MavenDependencyResolver - Class in software.amazon.smithy.cli.dependencies
-
Resolves Maven dependencies for the Smithy CLI using Maven resolvers.
- MavenDependencyResolver() - Constructor for class software.amazon.smithy.cli.dependencies.MavenDependencyResolver
- MavenDependencyResolver(String) - Constructor for class software.amazon.smithy.cli.dependencies.MavenDependencyResolver
- maxWidth(int) - Method in class software.amazon.smithy.cli.HelpPrinter
- Multi(Style...) - Constructor for class software.amazon.smithy.cli.Style.Multi
- MUTED - Static variable in class software.amazon.smithy.cli.ColorTheme
N
- NO_COLOR - Enum constant in enum class software.amazon.smithy.cli.AnsiColorFormatter
-
Does not write any color.
- NO_COLOR - Enum constant in enum class software.amazon.smithy.cli.EnvironmentVariable
-
If set to any value, disable ANSI colors in the output.
- NO_COLOR - Static variable in class software.amazon.smithy.cli.StandardOptions
- NOTE - Static variable in class software.amazon.smithy.cli.ColorTheme
- NOTE_TITLE - Static variable in class software.amazon.smithy.cli.ColorTheme
O
- of(String[]) - Static method in interface software.amazon.smithy.cli.Arguments
- of(ColorFormatter, Appendable) - Static method in class software.amazon.smithy.cli.ColorBuffer
-
Create a new ColorBuffer that directly writes to the given
sink. - of(ColorFormatter, CliPrinter) - Static method in class software.amazon.smithy.cli.ColorBuffer
-
Create a new ColorBuffer that stores all output to an internal buffer and only writes to the given
CliPrinterwhenColorBuffer.close()is called. - of(Style...) - Static method in interface software.amazon.smithy.cli.Style
- 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 interface software.amazon.smithy.cli.Arguments
-
Peeks at the next value in the argument 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(String, Style...) - Method in class software.amazon.smithy.cli.ColorBuffer
-
Writes styled text to the builder using the CliPrinter's color settings.
- print(ColorFormatter, CliPrinter) - Method in class software.amazon.smithy.cli.HelpPrinter
-
Prints the generated help to the given printer.
- println() - Method in class software.amazon.smithy.cli.ColorBuffer
-
Writes a system-dependent new line.
- println(Appendable, String, Style...) - Method in interface software.amazon.smithy.cli.ColorFormatter
-
Print a styled line of text to the given
appendable. - println(String) - Method in interface software.amazon.smithy.cli.CliPrinter
-
Prints text to the writer and appends a new line.
- println(String, Style...) - Method in class software.amazon.smithy.cli.ColorBuffer
-
Prints a line of styled text to the buffer.
- 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.
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.StandardOptions
- resolve() - Method in interface software.amazon.smithy.cli.dependencies.DependencyResolver
-
Resolves artifacts for the configured dependencies.
- resolve() - Method in class software.amazon.smithy.cli.dependencies.FileCacheResolver
- resolve() - Method in class software.amazon.smithy.cli.dependencies.FilterCliVersionResolver
- resolve() - Method in class software.amazon.smithy.cli.dependencies.MavenDependencyResolver
- ResolvedArtifact - Class in software.amazon.smithy.cli.dependencies
-
An artifact resolved from a repository that provides the path on disk where the artifact was downloaded, and the coordinates of the artifact.
- ResolvedArtifact(Path, String, String, String) - Constructor for class software.amazon.smithy.cli.dependencies.ResolvedArtifact
- 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.
S
- set(String) - Method in enum class software.amazon.smithy.cli.EnvironmentVariable
-
Sets a system property for the environment variable.
- shift() - Method in interface software.amazon.smithy.cli.Arguments
-
Shifts off the next value in the argument list or returns null.
- shiftFor(String) - Method in interface software.amazon.smithy.cli.Arguments
-
Expects an argument value for a parameter by name.
- SMITHY_DEPENDENCY_MODE - Enum constant in enum class software.amazon.smithy.cli.EnvironmentVariable
-
Configures if and how the Smithy CLI handles dependencies declared in smithy-build.json files.
- SMITHY_MAVEN_CACHE - Enum constant in enum class software.amazon.smithy.cli.EnvironmentVariable
-
A custom location for the Maven local repository cache.
- SMITHY_MAVEN_REPOS - Enum constant in enum class software.amazon.smithy.cli.EnvironmentVariable
-
A pipe-delimited list of Maven repositories to use.
- SMITHY_VERSION - Enum constant in enum class software.amazon.smithy.cli.EnvironmentVariable
-
The current version of the CLI.
- SmithyCli - Class in software.amazon.smithy.cli
-
Entry point of the Smithy CLI.
- SmithyCommand - Class in software.amazon.smithy.cli.commands
- SmithyCommand(DependencyResolver.Factory) - Constructor for class software.amazon.smithy.cli.commands.SmithyCommand
- software.amazon.smithy.cli - package software.amazon.smithy.cli
-
Everything in this package should be considered an implementation detail; the only stable interface of the Smithy CLI is passing in a list of arguments from the command line.
- software.amazon.smithy.cli.commands - package software.amazon.smithy.cli.commands
- software.amazon.smithy.cli.dependencies - package software.amazon.smithy.cli.dependencies
- 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
- startStyle(Appendable, Style...) - Method in interface software.amazon.smithy.cli.ColorFormatter
- 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(Appendable, String, Style...) - Method in interface software.amazon.smithy.cli.ColorFormatter
-
Styles text using the given styles and writes it to an Appendable.
- style(String, Style...) - Method in interface software.amazon.smithy.cli.ColorFormatter
-
Styles text using the given styles.
- style(Consumer<ColorBuffer>, Style...) - Method in class software.amazon.smithy.cli.ColorBuffer
- Style - Interface in software.amazon.smithy.cli
-
Colors and styles for use with
AnsiColorFormatterorCliPrinter. - Style.Constant - Class in software.amazon.smithy.cli
- Style.Multi - Class in software.amazon.smithy.cli
- SUCCESS - Static variable in class software.amazon.smithy.cli.ColorTheme
- 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.
- SUPPRESSED - Static variable in class software.amazon.smithy.cli.ColorTheme
- SUPPRESSED_TITLE - Static variable in class software.amazon.smithy.cli.ColorTheme
T
- tagMatcher(BuildParameterBuilder.ClassPathTagMatcher) - Method in class software.amazon.smithy.cli.BuildParameterBuilder
-
Sets the implementation used to find JARs with the given tags.
- TERM - Enum constant in enum class software.amazon.smithy.cli.EnvironmentVariable
-
Used to detect if ANSI colors are supported.
- 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.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.StandardOptions
- toString() - Method in class software.amazon.smithy.cli.ColorBuffer
- toString() - Method in class software.amazon.smithy.cli.dependencies.ResolvedArtifact
U
V
- valueOf(String) - Static method in enum class software.amazon.smithy.cli.AnsiColorFormatter
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.cli.EnvironmentVariable
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class software.amazon.smithy.cli.AnsiColorFormatter
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.cli.EnvironmentVariable
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WARNING - Static variable in class software.amazon.smithy.cli.ColorTheme
- WARNING_TITLE - Static variable in class software.amazon.smithy.cli.ColorTheme
- WHITE - Static variable in interface software.amazon.smithy.cli.Style
- withClassLoader(ClassLoader) - Method in class software.amazon.smithy.cli.Command.Env
- 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
A B C D E F G H I J L M N O P Q R S T U V W YAll Classes and Interfaces|All Packages|Constant Field Values|Serialized Form