Index (smithy-base 1.5.0 API)

A C D E F G I M N O P R S V W
All Classes and Interfaces|All Packages|Constant Field Values

A

addToAntBuilder(Object, String) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
addToAntBuilder(Object, String, FileCollection.AntType) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
apply(Project) - Method in class software.amazon.smithy.gradle.SmithyBasePlugin

C

CliConfig() - Constructor for class software.amazon.smithy.gradle.SmithyUtils.CliConfig
CliDependencyResolver - Class in software.amazon.smithy.gradle.internal: Utility class used to resolve the CLI version and associated CLI dependencies.
compiledBy(TaskProvider<T>, Function<T, DirectoryProperty>) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
configureLoggingOptions(List<String>) - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Add --stacktrace and --logging settings based on Gradle's settings.
contains(File) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet

D

DefaultSmithySourceDirectorySet - Class in software.amazon.smithy.gradle.internal: Default implementation of SmithySourceDirectorySet.
DefaultSmithySourceDirectorySet(SourceDirectorySet) - Constructor for class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
detectCliVersionInRuntimeDependencies(ConfigurationContainer) - Static method in class software.amazon.smithy.gradle.internal.CliDependencyResolver: Check if there's a dependency on smithy-model somewhere, and assume that version.

E

exclude(Closure) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
exclude(Iterable<String>) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
exclude(String...) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
exclude(Spec<FileTreeElement>) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
execute() - Method in class software.amazon.smithy.gradle.SmithyUtils.RunCli
execute() - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask
execute() - Method in class software.amazon.smithy.gradle.tasks.SmithyFormatCheckTask
execute() - Method in class software.amazon.smithy.gradle.tasks.SmithyFormatTask
execute() - Method in class software.amazon.smithy.gradle.tasks.SmithySelectTask
execute() - Method in class software.amazon.smithy.gradle.tasks.SmithyValidateTask
executeCli(WorkerExecutor, List<String>, FileCollection, boolean) - Static method in class software.amazon.smithy.gradle.SmithyUtils: Executes the Smithy CLI in a separate thread or process.
executeCliProcess(String, List<String>, FileCollection, boolean) - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Executes the given CLI command.

F

filter(Closure) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
filter(Spec<? super File>) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
formatModels(List<String>) - Method in class software.amazon.smithy.gradle.tasks.SmithyFormatTask

G

getAllowUnknownTraits() - Method in class software.amazon.smithy.gradle.SmithyExtension: Gets whether unknown traits in the model should be ignored.
getAllowUnknownTraits() - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Sets whether to fail a Smithy CLI task if an unknown trait is encountered.
getAsFileTree() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getAsPath() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getBuildClasspath() - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Classpath to use for build dependencies.
getBuildDependencies() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getClassesDirectory() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getCliClasspath() - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Base classpath used for executing the smithy cli.
getCliConfiguration(Project) - Static method in class software.amazon.smithy.gradle.SmithyUtils
getDestinationDirectory() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getDisableModelDiscovery() - Method in class software.amazon.smithy.gradle.tasks.SmithyValidateTask: Disable model discovery.
getDisplayName() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getElements() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getExcludes() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getFiles() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getFilter() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getFork() - Method in class software.amazon.smithy.gradle.SmithyExtension: Gets whether to fork when running the Smithy CLI.
getFork() - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Whether to fork a new process for executing the smithy cli.
getFormat() - Method in class software.amazon.smithy.gradle.SmithyExtension: Gets whether to execute the format task on files in the Smithy source set
getIncludes() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getModelDiscoveryClasspath() - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Classpath used for discovery of additional Smithy models during cli execution.
getModels() - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Gets the list of models to execute a CLI command on.
getName() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getOutputDir() - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Output directory for Smithy build artifacts.
getOutputDirectory() - Method in class software.amazon.smithy.gradle.SmithyExtension: Gets the output directory for running Smithy build.
getPluginProjectionDirectory(String, String) - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Convenience method to get the directory containing plugin artifacts.
getPluginProjectionPath(String, String) - Method in class software.amazon.smithy.gradle.SmithyExtension: Convenience method to get the directory containing plugin artifacts.
getProjectionOutputDirProperty(Project) - Static method in class software.amazon.smithy.gradle.SmithyUtils: Gets the provider for the default output directory of projections.
getProjectionPluginPath(File, String, String) - Static method in class software.amazon.smithy.gradle.SmithyUtils: Gets the path to a projection plugins output.
getProjectionSourceTags() - Method in class software.amazon.smithy.gradle.SmithyExtension: Get the tags that are searched for in classpaths when determining which models are projected into the created JAR.
getProjectionSourceTags() - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Tags that are searched for in classpaths when determining which models are projected into the created JAR.
getSeverity() - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Set the minimum reported validation severity.
getSeverity() - Method in class software.amazon.smithy.gradle.tasks.SmithyValidateTask: Set the minimum reported validation severity.
getShowStackTrace() - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Sets the detail to include in stack traces.
getSingleFile() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getSmithyBuildConfigs() - Method in class software.amazon.smithy.gradle.SmithyExtension: Gets a collection of smithy-build.json files to use when building the model.
getSmithyBuildConfigs() - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Smithy build configs to use for building models.
getSmithyResourceTempDir(String, File) - Static method in class software.amazon.smithy.gradle.SmithyUtils: Gets the path to the temp directory where Smithy model resources are placed in the generated JAR of a project.
getSourceDirectories() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getSourceProjection() - Method in class software.amazon.smithy.gradle.SmithyExtension: Gets the projection name in use by the extension as the source (primary) projection.
getSourceProjection() - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Projection to treat as the "source" or primary projection.
getSources() - Method in class software.amazon.smithy.gradle.tasks.SmithyValidateTask: Files to use as a sources for the Smithy CLI validate command.
getSourceSets() - Method in class software.amazon.smithy.gradle.SmithyExtension: Collection of SourceDirectorySet associated with the SmithyExtension.
getSrcDirs() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getSrcDirTrees() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
getTags() - Method in class software.amazon.smithy.gradle.SmithyExtension: Get the tags that are added to the JAR.

I

include(Closure) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
include(Iterable<String>) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
include(String...) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
include(Spec<FileTreeElement>) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
isEmpty() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
isMatchingDependency(Dependency, String) - Static method in class software.amazon.smithy.gradle.SmithyUtils: Checks if a dependency matches an expected name.
iterator() - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet

M

matching(Closure) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
matching(Action<? super PatternFilterable>) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
matching(PatternFilterable) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
minus(FileCollection) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet

N

NAME - Static variable in interface software.amazon.smithy.gradle.SmithySourceDirectorySet: Name of the source set extension contributed by the Smithy plugin.

O

objectFactory - Variable in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Object factory used to create new gradle domain objects such as FileCollections.

P

plus(FileCollection) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
plus(FileTree) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet

R

resolve(Project) - Static method in class software.amazon.smithy.gradle.internal.CliDependencyResolver: Add the CLI to the "smithyCli" dependencies.
RunCli() - Constructor for class software.amazon.smithy.gradle.SmithyUtils.RunCli

S

setExcludes(Iterable<String>) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
setIncludes(Iterable<String>) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
setSrcDirs(Iterable<?>) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
SMITHY_BUILD_TASK_NAME - Static variable in class software.amazon.smithy.gradle.SmithyBasePlugin: Default name to use for the SmithyBuildTask task created by this plugin.
SMITHY_CLI_CONFIGURATION_NAME - Static variable in class software.amazon.smithy.gradle.SmithyUtils
SMITHY_FORMAT_CHECK_TASK_NAME - Static variable in class software.amazon.smithy.gradle.SmithyBasePlugin: Default name to use for the SmithyFormatCheckTask task created by this plugin.
SMITHY_FORMAT_TASK_NAME - Static variable in class software.amazon.smithy.gradle.SmithyBasePlugin: Default name to use for the SmithyFormatTask task created by this plugin.
SMITHY_SELECT_TASK_NAME - Static variable in class software.amazon.smithy.gradle.SmithyBasePlugin: Default name to use for the SmithySelectTask task created by this plugin.
SmithyBasePlugin - Class in software.amazon.smithy.gradle: A Plugin that builds and validates Smithy models.
SmithyBasePlugin(Project) - Constructor for class software.amazon.smithy.gradle.SmithyBasePlugin
SmithyBuildTask - Class in software.amazon.smithy.gradle.tasks: Executes the Smithy CLI build command.
SmithyBuildTask(ObjectFactory, StartParameter) - Constructor for class software.amazon.smithy.gradle.tasks.SmithyBuildTask
SmithyExtension - Class in software.amazon.smithy.gradle: Gradle configuration settings for Smithy plugins.
SmithyExtension(Project, ObjectFactory) - Constructor for class software.amazon.smithy.gradle.SmithyExtension
SmithyFormatCheckTask - Class in software.amazon.smithy.gradle.tasks: Verifies that Smithy source files are already formatted without modifying them.
SmithyFormatCheckTask(ObjectFactory, StartParameter) - Constructor for class software.amazon.smithy.gradle.tasks.SmithyFormatCheckTask
SmithyFormatTask - Class in software.amazon.smithy.gradle.tasks: Executes the Smithy CLI format tool on a set of source files.
SmithyFormatTask(ObjectFactory, StartParameter) - Constructor for class software.amazon.smithy.gradle.tasks.SmithyFormatTask
SmithyGradleVersion - Class in software.amazon.smithy.gradle: Represents a Smithy-Gradle-Plugin version.
SmithySelectTask - Class in software.amazon.smithy.gradle.tasks: Executes the Smithy CLI select command on a set of source files.
SmithySelectTask(ObjectFactory, StartParameter) - Constructor for class software.amazon.smithy.gradle.tasks.SmithySelectTask
SmithySourceDirectorySet - Interface in software.amazon.smithy.gradle: A SmithySourceDirectorySet defines the properties and methods added to a SourceSet by the SmithyBasePlugin.
SmithyUtils - Class in software.amazon.smithy.gradle: General utility methods used throughout the plugin.
SmithyUtils.CliConfig - Class in software.amazon.smithy.gradle
SmithyUtils.RunCli - Class in software.amazon.smithy.gradle
SmithyValidateTask - Class in software.amazon.smithy.gradle.tasks: Validates the Smithy models.
SmithyValidateTask(ObjectFactory, StartParameter) - Constructor for class software.amazon.smithy.gradle.tasks.SmithyValidateTask
software.amazon.smithy.gradle - package software.amazon.smithy.gradle
software.amazon.smithy.gradle.internal - package software.amazon.smithy.gradle.internal
software.amazon.smithy.gradle.tasks - package software.amazon.smithy.gradle.tasks
source(SourceDirectorySet) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
SOURCE_DIRS - Static variable in interface software.amazon.smithy.gradle.SmithySourceDirectorySet: Source Directories this Source set will search for Smithy model files in.
srcDir(Object) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
srcDirs(Object...) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet

V

validateCliClasspath(FileCollection) - Static method in class software.amazon.smithy.gradle.internal.CliDependencyResolver: Checks that the provided classpath contains the smithy cli.
VERSION - Static variable in class software.amazon.smithy.gradle.SmithyGradleVersion
VERSION_OVERRIDE_VAR - Static variable in class software.amazon.smithy.gradle.SmithyGradleVersion
visit(Closure) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
visit(Action<? super FileVisitDetails>) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet
visit(FileVisitor) - Method in class software.amazon.smithy.gradle.internal.DefaultSmithySourceDirectorySet

W

writeHeading(String) - Method in class software.amazon.smithy.gradle.tasks.SmithyBuildTask: Writes header-formatted text to the build output.

A C D E F G I M N O P R S V W
All Classes and Interfaces|All Packages|Constant Field Values