A B C E F G H I J L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- addAllFiles(FileManifest) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds the files from another FileManifest into this FileManifest.
- addEvent(ValidationEvent) - Method in class software.amazon.smithy.build.ProjectionResult.Builder
-
Adds validation events to the result.
- addFile(Path) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a path to the manifest.
- addFile(Path) - Method in class software.amazon.smithy.build.MockManifest
- addPluginManifest(String, FileManifest) - Method in class software.amazon.smithy.build.ProjectionResult.Builder
-
Adds a plugin result.
- addProjectionResult(ProjectionResult) - Method in class software.amazon.smithy.build.SmithyBuildResult.Builder
-
Adds a projection result to the builder.
- allArtifacts() - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Gets all of the artifacts written during the build.
- allManifests() - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Gets all of the manifests that were used in the build.
- anyBroken() - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Returns true if any projected models contain error or danger events.
- apply(Node) - Method in class software.amazon.smithy.build.JsonSubstitutions
-
Replaces strings in the given node.
- args(List<String>) - Method in class software.amazon.smithy.build.model.TransformConfig.Builder
-
Sets the args of the transform.
B
- build() - Method in class software.amazon.smithy.build.model.ProjectionConfig.Builder
-
Builds the projection.
- build() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
- build() - Method in class software.amazon.smithy.build.model.TransformConfig.Builder
- build() - Method in class software.amazon.smithy.build.PluginContext.Builder
- build() - Method in class software.amazon.smithy.build.ProjectionResult.Builder
- build() - Method in class software.amazon.smithy.build.SmithyBuild
-
Builds the model and applies all projections.
- build() - Method in class software.amazon.smithy.build.SmithyBuildResult.Builder
- builder() - Static method in class software.amazon.smithy.build.model.ProjectionConfig
- builder() - Static method in class software.amazon.smithy.build.model.SmithyBuildConfig
- builder() - Static method in class software.amazon.smithy.build.model.TransformConfig
- builder() - Static method in class software.amazon.smithy.build.PluginContext
-
Creates a new PluginContext Builder.
- builder() - Static method in class software.amazon.smithy.build.ProjectionResult
-
Creates a
ProjectionResult
builder. - builder() - Static method in class software.amazon.smithy.build.SmithyBuildResult
-
Creates a builder used to build SmithyBuildResult.
- Builder() - Constructor for class software.amazon.smithy.build.ProjectionResult.Builder
- BuildInfoPlugin - Class in software.amazon.smithy.build.plugins
-
Writes a build info file for each projection.
- BuildInfoPlugin() - Constructor for class software.amazon.smithy.build.plugins.BuildInfoPlugin
C
- config(Path) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets the required configuration object used to build the model.
- config(SmithyBuildConfig) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets the required configuration object used to build the model.
- create(ClassLoader) - Static method in class software.amazon.smithy.build.SmithyBuild
-
Creates a
SmithyBuild
implementation that is configured to discover various Smithy service providers using the givenClassLoader
. - create(ClassLoader, Supplier<ModelAssembler>) - Static method in class software.amazon.smithy.build.SmithyBuild
-
Creates a
SmithyBuild
implementation that is configured to discover various Smithy service providers using the givenClassLoader
. - create(Path) - Static method in interface software.amazon.smithy.build.FileManifest
-
Create a default file manifest for the given base path.
- create(Map<String, Node>) - Static method in class software.amazon.smithy.build.JsonSubstitutions
-
Creates a substitutions instance from a Map.
- create(ObjectNode) - Static method in class software.amazon.smithy.build.JsonSubstitutions
-
Creates a substitutions instance from an ObjectNode.
- createServiceFactory() - Static method in interface software.amazon.smithy.build.ProjectionTransformer
-
Creates a
ProjectionTransformer
factory function using SPI and the current thread's context class loader. - createServiceFactory() - Static method in interface software.amazon.smithy.build.SmithyBuildPlugin
-
Creates a SmithyBuildPlugin factory function using SPI and the current Thread's context class loader.
- createServiceFactory(ClassLoader) - Static method in interface software.amazon.smithy.build.ProjectionTransformer
-
Creates a
ProjectionTransformer
factory function using SPI. - createServiceFactory(ClassLoader) - Static method in interface software.amazon.smithy.build.SmithyBuildPlugin
-
Creates a SmithyBuildPlugin factory function using SPI.
- createServiceFactory(Iterable<ProjectionTransformer>) - Static method in interface software.amazon.smithy.build.ProjectionTransformer
-
Creates a
ProjectionTransformer
factory function using the given transformers. - createServiceFactory(Iterable<SmithyBuildPlugin>) - Static method in interface software.amazon.smithy.build.SmithyBuildPlugin
-
Creates a factory function used that creates SmithyBuildPlugins using a list of resolved plugins.
- createTransformer(List<String>) - Method in interface software.amazon.smithy.build.ProjectionTransformer
-
Creates a function that transforms a model using the provided
ModelTransformer
. - createTransformer(List<String>) - Method in class software.amazon.smithy.build.transforms.ExcludeMetadata
- createTransformer(List<String>) - Method in class software.amazon.smithy.build.transforms.ExcludeShapesByTag
- createTransformer(List<String>) - Method in class software.amazon.smithy.build.transforms.ExcludeTraits
- createTransformer(List<String>) - Method in class software.amazon.smithy.build.transforms.ExcludeTraitsByTag
- createTransformer(List<String>) - Method in class software.amazon.smithy.build.transforms.IncludeAuth
- createTransformer(List<String>) - Method in class software.amazon.smithy.build.transforms.IncludeMetadata
- createTransformer(List<String>) - Method in class software.amazon.smithy.build.transforms.IncludeNamespaces
- createTransformer(List<String>) - Method in class software.amazon.smithy.build.transforms.IncludeProtocols
- createTransformer(List<String>) - Method in class software.amazon.smithy.build.transforms.IncludeServices
- createTransformer(List<String>) - Method in class software.amazon.smithy.build.transforms.IncludeShapesByTag
- createTransformer(List<String>) - Method in class software.amazon.smithy.build.transforms.IncludeTraits
- createTransformer(List<String>) - Method in class software.amazon.smithy.build.transforms.IncludeTraitsByTag
- createTransformer(List<String>) - Method in class software.amazon.smithy.build.transforms.RemoveUnusedShapes
E
- events(List<ValidationEvent>) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets the validation events that occurred after projecting the model.
- events(List<ValidationEvent>) - Method in class software.amazon.smithy.build.ProjectionResult.Builder
-
Sets the validation events of the projection.
- ExcludeMetadata - Class in software.amazon.smithy.build.transforms
-
Removes metadata entries when a key matches any of the given arguments.
- ExcludeMetadata() - Constructor for class software.amazon.smithy.build.transforms.ExcludeMetadata
- ExcludeShapesByTag - Class in software.amazon.smithy.build.transforms
-
Removes shapes if they are tagged with one or more of the given arguments.
- ExcludeShapesByTag() - Constructor for class software.amazon.smithy.build.transforms.ExcludeShapesByTag
- ExcludeTags - Class in software.amazon.smithy.build.transforms
-
Removes tags from shapes and trait definitions that match any of the provided arguments (a list of allowed tags).
- ExcludeTags() - Constructor for class software.amazon.smithy.build.transforms.ExcludeTags
- ExcludeTraits - Class in software.amazon.smithy.build.transforms
-
Removes trait definitions and traits from shapes when a trait name matches any of the given arguments.
- ExcludeTraits() - Constructor for class software.amazon.smithy.build.transforms.ExcludeTraits
- ExcludeTraitsByTag - Class in software.amazon.smithy.build.transforms
-
Removes traits and trait definitions from a model if the trait definition contains any of the provided tags.
- ExcludeTraitsByTag() - Constructor for class software.amazon.smithy.build.transforms.ExcludeTraitsByTag
- execute(PluginContext) - Method in class software.amazon.smithy.build.plugins.BuildInfoPlugin
- execute(PluginContext) - Method in class software.amazon.smithy.build.plugins.ModelPlugin
- execute(PluginContext) - Method in class software.amazon.smithy.build.plugins.SourcesPlugin
- execute(PluginContext) - Method in interface software.amazon.smithy.build.SmithyBuildPlugin
-
Executes the plugin, creating any number of artifacts.
- expectFileBytes(String) - Method in class software.amazon.smithy.build.MockManifest
-
Expects that the given file was stored and returns the bytes.
- expectFileBytes(Path) - Method in class software.amazon.smithy.build.MockManifest
-
Expects that the given file was stored and returns the bytes.
- expectFileString(String) - Method in class software.amazon.smithy.build.MockManifest
-
Expects that the given file was stored and returns a UTF-8 string.
- expectFileString(Path) - Method in class software.amazon.smithy.build.MockManifest
-
Expects that the given file was stored and returns a UTF-8 string.
F
- fileManifest(FileManifest) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets the required
FileManifest
to use in the plugin. - FileManifest - Interface in software.amazon.smithy.build
-
Creates and tracks the files generated by a
SmithyBuildPlugin
. - fileManifestFactory(Function<Path, FileManifest>) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets a factory function that's used to create
FileManifest
objects when writingSmithyBuildPlugin
artifacts.
G
- getAliases() - Method in interface software.amazon.smithy.build.ProjectionTransformer
-
Returns a list of aliases that the transformer also answers to.
- getAliases() - Method in interface software.amazon.smithy.build.SmithyBuildPlugin
-
Returns a list of aliases that the plugin also answers to.
- getAliases() - Method in class software.amazon.smithy.build.transforms.ExcludeShapesByTag
- getAliases() - Method in class software.amazon.smithy.build.transforms.IncludeAuth
- getAliases() - Method in class software.amazon.smithy.build.transforms.IncludeShapesByTag
- getAliases() - Method in class software.amazon.smithy.build.transforms.RemoveUnusedShapes
- getArgs() - Method in class software.amazon.smithy.build.model.TransformConfig
- getBaseDir() - Method in interface software.amazon.smithy.build.FileManifest
-
Gets the base directory of the manifest.
- getBaseDir() - Method in class software.amazon.smithy.build.MockManifest
- getEvents() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the validation events encountered after projecting the model.
- getEvents() - Method in class software.amazon.smithy.build.ProjectionResult
-
Gets the validation events encountered after projecting the model.
- getFileBytes(String) - Method in class software.amazon.smithy.build.MockManifest
-
Gets the bytes of a stored file.
- getFileBytes(Path) - Method in class software.amazon.smithy.build.MockManifest
-
Gets the bytes of a stored file.
- getFileManifest() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the FileManifest used to create files in the projection.
- getFiles() - Method in interface software.amazon.smithy.build.FileManifest
-
Gets all of the files in the result.
- getFiles() - Method in class software.amazon.smithy.build.MockManifest
- getFilesIn(String) - Method in interface software.amazon.smithy.build.FileManifest
-
Gets the paths to files stored under a prefix.
- getFilesIn(Path) - Method in interface software.amazon.smithy.build.FileManifest
-
Gets the paths to files stored under a prefix.
- getFileString(String) - Method in class software.amazon.smithy.build.MockManifest
-
Gets the contents of a stored file as a String.
- getFileString(Path) - Method in class software.amazon.smithy.build.MockManifest
-
Gets the contents of a stored file as a String.
- getImportBasePath() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
-
Gets the base path of where the config file was loaded from.
- getImports() - Method in class software.amazon.smithy.build.model.ProjectionConfig
-
Gets the imports configured for the projection.
- getImports() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
-
Gets the paths to all of the models to import.
- getModel() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the model that was projected.
- getModel() - Method in class software.amazon.smithy.build.ProjectionResult
-
Gets the result of projecting the model.
- getName() - Method in class software.amazon.smithy.build.model.TransformConfig
- getName() - Method in class software.amazon.smithy.build.plugins.BuildInfoPlugin
- getName() - Method in class software.amazon.smithy.build.plugins.ModelPlugin
- getName() - Method in class software.amazon.smithy.build.plugins.SourcesPlugin
- getName() - Method in interface software.amazon.smithy.build.ProjectionTransformer
-
Gets the name of the transformer.
- getName() - Method in interface software.amazon.smithy.build.SmithyBuildPlugin
-
Gets the name of the plugin.
- getName() - Method in class software.amazon.smithy.build.transforms.ExcludeMetadata
- getName() - Method in class software.amazon.smithy.build.transforms.ExcludeShapesByTag
- getName() - Method in class software.amazon.smithy.build.transforms.ExcludeTags
- getName() - Method in class software.amazon.smithy.build.transforms.ExcludeTraits
- getName() - Method in class software.amazon.smithy.build.transforms.ExcludeTraitsByTag
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeAuth
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeMetadata
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeNamespaces
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeProtocols
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeServices
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeShapesByTag
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeTags
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeTraits
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeTraitsByTag
- getName() - Method in class software.amazon.smithy.build.transforms.RemoveUnusedShapes
- getOriginalModel() - Method in class software.amazon.smithy.build.PluginContext
-
Get the original model before applying the projection.
- getOutputDirectory() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
- getPluginClassLoader() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the ClassLoader that should be used in build plugins to load services.
- getPluginManifest(String) - Method in class software.amazon.smithy.build.ProjectionResult
-
Gets the result of a specific plugin.
- getPluginManifests() - Method in class software.amazon.smithy.build.ProjectionResult
-
Gets the results of each plugin.
- getPlugins() - Method in class software.amazon.smithy.build.model.ProjectionConfig
- getPlugins() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
-
Gets the globally configured plugins that are applied to every projection.
- getProjection() - Method in class software.amazon.smithy.build.PluginContext
- getProjectionName() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the name of the projection being applied.
- getProjectionName() - Method in class software.amazon.smithy.build.ProjectionResult
-
Gets the name of the projection that was executed.
- getProjectionResult(String) - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Gets a projection result by name.
- getProjectionResults() - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Gets all of the projection results as an unmodifiable list.
- getProjectionResultsMap() - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Gets all of the projection results as a map of projection name to
ProjectionResult
. - getProjections() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
-
Gets all of the configured projections.
- getSettings() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the plugin configuration settings.
- getSources() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the source models, or models that are considered the subject of the build.
- getTransforms() - Method in class software.amazon.smithy.build.model.ProjectionConfig
H
- hasFile(String) - Method in interface software.amazon.smithy.build.FileManifest
-
Checks if the given file is stored in the manifest.
- hasFile(Path) - Method in interface software.amazon.smithy.build.FileManifest
-
Checks if the given file is stored in the manifest.
I
- importBasePath(Path) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets the base path for where imports are found.
- imports(Collection<String>) - Method in class software.amazon.smithy.build.model.ProjectionConfig.Builder
-
Sets the imports of the projection.
- imports(Collection<String>) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Sets imports on the config.
- IN_MEMORY - software.amazon.smithy.build.MockManifest.StoreMode
-
Store all saved files in memory.
- IncludeAuth - Class in software.amazon.smithy.build.transforms
-
Removes authentication schemes from "auth" traits and from the "auth" property of protocols that do not match one of the given arguments (a list of authentication schemes).
- IncludeAuth() - Constructor for class software.amazon.smithy.build.transforms.IncludeAuth
- IncludeMetadata - Class in software.amazon.smithy.build.transforms
-
Removes metadata entries when a key does not match any of the given arguments.
- IncludeMetadata() - Constructor for class software.amazon.smithy.build.transforms.IncludeMetadata
- IncludeNamespaces - Class in software.amazon.smithy.build.transforms
-
Filters out shapes and trait definitions that are not part of one of the given namespaces.
- IncludeNamespaces() - Constructor for class software.amazon.smithy.build.transforms.IncludeNamespaces
- IncludeProtocols - Class in software.amazon.smithy.build.transforms
-
Removes protocols from service shapes that do not match one of the given arguments (a list of protocol names).
- IncludeProtocols() - Constructor for class software.amazon.smithy.build.transforms.IncludeProtocols
- IncludeServices - Class in software.amazon.smithy.build.transforms
-
Filters out service shapes that are not included in the arguments list of service shape IDs.
- IncludeServices() - Constructor for class software.amazon.smithy.build.transforms.IncludeServices
- IncludeShapesByTag - Class in software.amazon.smithy.build.transforms
-
Removes shapes and trait definitions that are not tagged with at least one of the given trait arguments.
- IncludeShapesByTag() - Constructor for class software.amazon.smithy.build.transforms.IncludeShapesByTag
- IncludeTags - Class in software.amazon.smithy.build.transforms
-
Removes tags from shapes and trait definitions that are not in the argument list (a list of allowed tags).
- IncludeTags() - Constructor for class software.amazon.smithy.build.transforms.IncludeTags
- IncludeTraits - Class in software.amazon.smithy.build.transforms
-
Removes trait definitions when a trait name does not match one of the arguments (a list of trait names).
- IncludeTraits() - Constructor for class software.amazon.smithy.build.transforms.IncludeTraits
- IncludeTraitsByTag - Class in software.amazon.smithy.build.transforms
-
Removes trait definitions from a model if the definition does not contain at least one of the provided tags.
- IncludeTraitsByTag() - Constructor for class software.amazon.smithy.build.transforms.IncludeTraitsByTag
- isAbstract() - Method in class software.amazon.smithy.build.model.ProjectionConfig
- isAbstract(boolean) - Method in class software.amazon.smithy.build.model.ProjectionConfig.Builder
-
Sets the
abstract
property of the projection. - isBroken() - Method in class software.amazon.smithy.build.ProjectionResult
-
Returns true if the projection contains error or danger events.
- isEmpty() - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Checks if the results is empty.
- isSourceMetadata(String) - Method in class software.amazon.smithy.build.PluginContext
-
Checks if the given metadata key-value pair is either not present in the old model (thus a new, source metadata), or is present and the filename of the entry in the original model matches one of the defined
sources
. - isSourceShape(ToShapeId) - Method in class software.amazon.smithy.build.PluginContext
-
Checks if the given shape/ID is either not present in the original model (thus a new, source shape), or is present and the filename of the shape in the original model matches one of the defined
sources
.
J
- JsonSubstitutions - Class in software.amazon.smithy.build
-
Finds string set in a Node object string value and replaces them with a corresponding Node.
L
- load(Path) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Loads and merges the config file into the builder.
- load(Path) - Static method in class software.amazon.smithy.build.model.SmithyBuildConfig
-
Loads a SmithyBuildConfig from a JSON file on disk.
M
- merge(SmithyBuildConfig) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Updates this configuration with the configuration of another file.
- MockManifest - Class in software.amazon.smithy.build
-
A
FileManifest
that doesn't actually store files on disk. - MockManifest() - Constructor for class software.amazon.smithy.build.MockManifest
-
Creates a mock manifest that stores files in memory and uses a base directory of "/".
- MockManifest(Path) - Constructor for class software.amazon.smithy.build.MockManifest
-
Creates a mock manifest that stores files in memory.
- MockManifest(Path, MockManifest.StoreMode) - Constructor for class software.amazon.smithy.build.MockManifest
- MockManifest.StoreMode - Enum in software.amazon.smithy.build
-
The way in which files are stored.
- model(Model) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets the required model that is being built.
- model(Model) - Method in class software.amazon.smithy.build.ProjectionResult.Builder
-
Sets the required model that was projected.
- model(Model) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets an optional model to use with the build.
- modelAssemblerSupplier(Supplier<ModelAssembler>) - Method in class software.amazon.smithy.build.SmithyBuild
-
Called to create
ModelAssembler
to load the original model and to load each projected model. - ModelPlugin - Class in software.amazon.smithy.build.plugins
-
Writes the projected/filtered SmithyBuild model.
- ModelPlugin() - Constructor for class software.amazon.smithy.build.plugins.ModelPlugin
- modelTransformer(ModelTransformer) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets a custom
ModelTransformer
to use when building projections.
N
- name(String) - Method in class software.amazon.smithy.build.model.TransformConfig.Builder
-
Sets the required name.
O
- originalModel(Model) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets the model that is being built before it was transformed in the projection.
- outputDirectory(String) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Set a directory where the build artifacts are written.
- outputDirectory(String) - Method in class software.amazon.smithy.build.SmithyBuild
-
Set a directory where the build artifacts are written.
- outputDirectory(Path) - Method in class software.amazon.smithy.build.SmithyBuild
-
Set a directory where the build artifacts are written.
P
- PATH_ONLY - software.amazon.smithy.build.MockManifest.StoreMode
-
Store only the path of each saved file.
- pluginClassLoader(ClassLoader) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets a ClassLoader that should be used by build plugins when loading services.
- pluginClassLoader(ClassLoader) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets a ClassLoader that should be used by SmithyBuild plugins when discovering services.
- PluginContext - Class in software.amazon.smithy.build
-
Context object used in plugin execution.
- PluginContext.Builder - Class in software.amazon.smithy.build
-
Builds a
PluginContext
. - pluginFactory(Function<String, Optional<SmithyBuildPlugin>>) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets a factory function used to create plugins by name.
- pluginFilter(Predicate<String>) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets a predicate that accepts the name of a plugin and returns true if the plugin should be built.
- plugins(Map<String, ObjectNode>) - Method in class software.amazon.smithy.build.model.ProjectionConfig.Builder
-
Sets the plugins of the projection.
- plugins(Map<String, ObjectNode>) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Sets plugins on the config.
- projection(String, ProjectionConfig) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets the projection that the plugin belongs to.
- ProjectionConfig - Class in software.amazon.smithy.build.model
-
ProjectionConfig stored in a
SmithyBuildConfig
. - ProjectionConfig.Builder - Class in software.amazon.smithy.build.model
-
Builds a
ProjectionConfig
. - projectionFilter(Predicate<String>) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets a predicate that accepts the name of a projection and returns true if the projection should be built.
- projectionName(String) - Method in class software.amazon.smithy.build.ProjectionResult.Builder
-
Sets the required projection name.
- ProjectionResult - Class in software.amazon.smithy.build
-
The result of applying a projection to a model.
- ProjectionResult.Builder - Class in software.amazon.smithy.build
-
Builds up a
ProjectionResult
. - projections(Map<String, ProjectionConfig>) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Sets projections on the config.
- ProjectionTransformer - Interface in software.amazon.smithy.build
-
Creates a model transformer by name.
R
- registerSources(Path...) - Method in class software.amazon.smithy.build.SmithyBuild
-
Registers the given paths as sources of the model being built.
- RemoveUnusedShapes - Class in software.amazon.smithy.build.transforms
-
Removes shapes from the model that are not connected to any service shape.
- RemoveUnusedShapes() - Constructor for class software.amazon.smithy.build.transforms.RemoveUnusedShapes
- requiresValidModel() - Method in class software.amazon.smithy.build.plugins.BuildInfoPlugin
- requiresValidModel() - Method in interface software.amazon.smithy.build.SmithyBuildPlugin
-
Plugins can choose whether or not to create artifacts based on whether or not the projection encountered error or unsuppressed danger events.
- resolvePath(Path) - Method in interface software.amazon.smithy.build.FileManifest
-
Resolves a path against the base path of the manifest.
S
- settings(ObjectNode) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets the settings of the plugin.
- size() - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Gets the number of projection results in the map.
- SmithyBuild - Class in software.amazon.smithy.build
-
Runs the projections and plugins found in a
SmithyBuildConfig
and writes the artifacts to aFileManifest
. - SmithyBuild() - Constructor for class software.amazon.smithy.build.SmithyBuild
- SmithyBuild(SmithyBuildConfig) - Constructor for class software.amazon.smithy.build.SmithyBuild
- SmithyBuildConfig - Class in software.amazon.smithy.build.model
-
Filter configuration that contains a list of named projections that are used to apply filters to a model.
- SmithyBuildConfig.Builder - Class in software.amazon.smithy.build.model
-
Builder used to create a
SmithyBuildConfig
. - SmithyBuildException - Exception in software.amazon.smithy.build
-
Base exception thrown for any error that occurs while building.
- SmithyBuildException(String) - Constructor for exception software.amazon.smithy.build.SmithyBuildException
- SmithyBuildException(String, Throwable) - Constructor for exception software.amazon.smithy.build.SmithyBuildException
- SmithyBuildException(Throwable) - Constructor for exception software.amazon.smithy.build.SmithyBuildException
- SmithyBuildPlugin - Interface in software.amazon.smithy.build
-
Plugin extension class for SmithyBuild.
- SmithyBuildResult - Class in software.amazon.smithy.build
-
Encapsulates the result of running SmithyBuild.
- SmithyBuildResult.Builder - Class in software.amazon.smithy.build
-
Creates a SmithyBuildResult.
- software.amazon.smithy.build - package software.amazon.smithy.build
- software.amazon.smithy.build.model - package software.amazon.smithy.build.model
- software.amazon.smithy.build.plugins - package software.amazon.smithy.build.plugins
- software.amazon.smithy.build.transforms - package software.amazon.smithy.build.transforms
- sources(Collection<Path>) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets the path to models that are considered "source" models of the package being built.
- SourcesConflictException - Exception in software.amazon.smithy.build
-
Thrown when sources conflict in the source plugin.
- SourcesConflictException(String) - Constructor for exception software.amazon.smithy.build.SourcesConflictException
- SourcesPlugin - Class in software.amazon.smithy.build.plugins
-
Copies model sources into the sources plugin.
- SourcesPlugin() - Constructor for class software.amazon.smithy.build.plugins.SourcesPlugin
T
- toBuilder() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
- toNode() - Method in class software.amazon.smithy.build.model.ProjectionConfig
- toNode() - Method in class software.amazon.smithy.build.model.TransformConfig
- TransformConfig - Class in software.amazon.smithy.build.model
-
Transform configuration found in a projection.
- TransformConfig.Builder - Class in software.amazon.smithy.build.model
- transformFactory(Function<String, Optional<ProjectionTransformer>>) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets a factory function used to create transforms by name.
- transforms(Collection<TransformConfig>) - Method in class software.amazon.smithy.build.model.ProjectionConfig.Builder
-
Sets the transforms of the projection.
U
- UnknownProjectionException - Exception in software.amazon.smithy.build
-
Thrown when a projection extends from an unknown projection.
- UnknownProjectionException(String) - Constructor for exception software.amazon.smithy.build.UnknownProjectionException
- UnknownProjectionException(String, Throwable) - Constructor for exception software.amazon.smithy.build.UnknownProjectionException
- UnknownTransformException - Exception in software.amazon.smithy.build
-
Thrown when a mapper cannot be found.
- UnknownTransformException(String) - Constructor for exception software.amazon.smithy.build.UnknownTransformException
- UnknownTransformException(String, Throwable) - Constructor for exception software.amazon.smithy.build.UnknownTransformException
V
- valueOf(String) - Static method in enum software.amazon.smithy.build.MockManifest.StoreMode
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum software.amazon.smithy.build.MockManifest.StoreMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- writeFile(String, InputStream) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a file to the result using the contents of an
InputStream
. - writeFile(String, Reader) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a file to the result using the contents of a
Reader
. - writeFile(String, String) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a UTF-8 encoded file to the result.
- writeFile(Path, InputStream) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a file to the result using the contents of an
InputStream
. - writeFile(Path, InputStream) - Method in class software.amazon.smithy.build.MockManifest
- writeFile(Path, Reader) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a file to the result using the contents of a
Reader
. - writeFile(Path, Reader) - Method in class software.amazon.smithy.build.MockManifest
- writeFile(Path, String) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a UTF-8 encoded file to the result.
- writeJson(String, Node) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a Node artifact, converting it automatically to JSON.
- writeJson(Path, Node) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a Node artifact, converting it automatically to JSON.
All Classes All Packages