Index

A B C D E F G H I J L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addDependencies(SymbolDependencyContainer) - Method in class software.amazon.smithy.codegen.core.DependencyTracker
Adds dependencies from a SymbolDependencyContainer.
addDependenciesFromJson(URL) - Method in class software.amazon.smithy.codegen.core.DependencyTracker
Loads predefined dependencies from a JSON file (for example, to track known dependencies used by generated code at runtime).
addDependency(String, String) - Method in class software.amazon.smithy.codegen.core.Symbol.Builder
Add a symbol dependency.
addDependency(String, String, String) - Method in class software.amazon.smithy.codegen.core.DependencyTracker
Adds a dependency.
addDependency(String, String, String) - Method in class software.amazon.smithy.codegen.core.Symbol.Builder
Add a symbol dependency.
addDependency(SymbolDependency) - Method in class software.amazon.smithy.codegen.core.DependencyTracker
Adds a dependency.
addDependency(SymbolDependencyContainer) - Method in class software.amazon.smithy.codegen.core.Symbol.Builder
Add a symbol dependency.
addDependency(SymbolDependencyContainer) - Method in class software.amazon.smithy.codegen.core.SymbolWriter
Adds one or more dependencies to the generated code (represented as a SymbolDependency).
addDependency(SymbolDependencyContainer) - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriter
Deprecated.
Adds one or more dependencies to the generated code (represented as a SymbolDependency).
addDependency(SymbolDependencyContainer) - Method in class software.amazon.smithy.codegen.core.writer.SymbolWriter
Deprecated.
Adds one or more dependencies to the generated code (represented as a SymbolDependency).
addImport(Symbol, String, SymbolReference.ContextOption...) - Method in class software.amazon.smithy.codegen.core.SymbolWriter
Imports a symbol (if necessary) using a specific alias and list of context options.
addImport(Symbol, String, SymbolReference.ContextOption...) - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriter
Deprecated.
Imports a symbol (if necessary) using a specific alias and list of context options.
addImport(Symbol, String, SymbolReference.ContextOption...) - Method in class software.amazon.smithy.codegen.core.writer.SymbolWriter
Deprecated.
Imports a symbol (if necessary) using a specific alias and list of context options.
addReference(Symbol) - Method in class software.amazon.smithy.codegen.core.Symbol.Builder
Add a symbol reference to indicate that this symbol points to or contains references to other symbols.
addReference(SymbolReference) - Method in class software.amazon.smithy.codegen.core.Symbol.Builder
Add a symbol reference to indicate that this symbol points to or contains references to other symbols.
addShapeLink(String, ShapeLink) - Method in class software.amazon.smithy.codegen.core.trace.TraceFile.Builder
Adds a ShapeLink to this ShapeId in the TraceFile's shapes map.
addShapeLink(ShapeId, ShapeLink) - Method in class software.amazon.smithy.codegen.core.trace.TraceFile.Builder
Adds a ShapeLink to this ShapeId in the TraceFile's shapes map.
addShapeLinks(String, List<ShapeLink>) - Method in class software.amazon.smithy.codegen.core.trace.TraceFile.Builder
Adds a list of ShapeLinks to this ShapeId in the TraceFile's shapes map.
addShapeLinks(ShapeId, List<ShapeLink>) - Method in class software.amazon.smithy.codegen.core.trace.TraceFile.Builder
Adds a list of ShapeLinks to this ShapeId in the TraceFile's shapes map.
addTag(String) - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink.Builder
Adds a tag to the tags list of a ShapeLink.
addTag(String, String) - Method in class software.amazon.smithy.codegen.core.trace.ArtifactDefinitions.Builder
Adds the tag's key, value pair to the tags map.
addType(String, String) - Method in class software.amazon.smithy.codegen.core.trace.ArtifactDefinitions.Builder
Adds the type's key, value pair to the tags map.
addUseImports(SymbolContainer) - Method in class software.amazon.smithy.codegen.core.SymbolWriter
Imports one or more USE symbols using the name of the symbol (e.g., SymbolReference.ContextOption.USE references).
addUseImports(SymbolContainer) - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriter
Deprecated.
Imports one or more USE symbols using the name of the symbol (e.g., SymbolReference.ContextOption.USE references).
addUseImports(SymbolContainer) - Method in class software.amazon.smithy.codegen.core.writer.SymbolWriter
Deprecated.
Imports one or more USE symbols using the name of the symbol (e.g., SymbolReference.ContextOption.USE references).
addUseImports(SymbolReference) - Method in class software.amazon.smithy.codegen.core.SymbolWriter
Imports a USE symbols possibly using an alias of the symbol (e.g., SymbolReference.ContextOption.USE references).
addUseImports(SymbolReference) - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriter
Deprecated.
Imports a USE symbols possibly using an alias of the symbol (e.g., SymbolReference.ContextOption.USE references).
addUseImports(SymbolReference) - Method in class software.amazon.smithy.codegen.core.writer.SymbolWriter
Deprecated.
Imports a USE symbols possibly using an alias of the symbol (e.g., SymbolReference.ContextOption.USE references).
alias(String) - Method in class software.amazon.smithy.codegen.core.SymbolReference.Builder
Adds an alias to the SymbolReference.
apply(String, String) - Method in interface software.amazon.smithy.codegen.core.SymbolWriter.Factory
Creates a SymbolWriter of type W for the given filename and namespace.
apply(String, String) - Method in interface software.amazon.smithy.codegen.core.writer.CodegenWriterFactory
Deprecated.
Creates a CodegenWriter of type T for the given filename and namespace.
artifactDefinitions(ArtifactDefinitions) - Method in class software.amazon.smithy.codegen.core.trace.TracingSymbolProvider.Builder
Sets this Builder's ArtifactDefinitions.
ArtifactDefinitions - Class in software.amazon.smithy.codegen.core.trace
Class that defines the acceptable values that can be used in ShapeLink objects.
ArtifactDefinitions.Builder - Class in software.amazon.smithy.codegen.core.trace
 

B

build() - Method in class software.amazon.smithy.codegen.core.MappedReservedWords.Builder
Builds the reserved words.
build() - Method in class software.amazon.smithy.codegen.core.ReservedWordsBuilder
Builds the reserved words.
build() - Method in class software.amazon.smithy.codegen.core.ReservedWordSymbolProvider.Builder
Builds a SymbolProvider implementation that wraps another symbol provider and escapes its results.
build() - Method in class software.amazon.smithy.codegen.core.Symbol.Builder
 
build() - Method in class software.amazon.smithy.codegen.core.SymbolDependency.Builder
 
build() - Method in class software.amazon.smithy.codegen.core.SymbolReference.Builder
 
build() - Method in class software.amazon.smithy.codegen.core.trace.ArtifactDefinitions.Builder
 
build() - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink.Builder
 
build() - Method in class software.amazon.smithy.codegen.core.trace.TraceFile.Builder
 
build() - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata.Builder
 
build() - Method in class software.amazon.smithy.codegen.core.trace.TracingSymbolProvider.Builder
Builds a TracingSymbolProvider implementation.
build() - Method in class software.amazon.smithy.codegen.core.writer.JavaStyleDocumentationWriterBuilder
Deprecated.
Creates a DocumentationWriter configured by the builder.
builder() - Static method in class software.amazon.smithy.codegen.core.MappedReservedWords
 
builder() - Static method in class software.amazon.smithy.codegen.core.ReservedWordSymbolProvider
Builder to create a ReservedWordSymbolProvider instance.
builder() - Static method in class software.amazon.smithy.codegen.core.Symbol
Creates a new Symbol builder.
builder() - Static method in class software.amazon.smithy.codegen.core.SymbolDependency
 
builder() - Static method in class software.amazon.smithy.codegen.core.SymbolReference
 
builder() - Static method in class software.amazon.smithy.codegen.core.trace.ArtifactDefinitions
 
builder() - Static method in class software.amazon.smithy.codegen.core.trace.ShapeLink
 
builder() - Static method in class software.amazon.smithy.codegen.core.trace.TraceFile
 
builder() - Static method in class software.amazon.smithy.codegen.core.trace.TraceMetadata
 
builder() - Static method in class software.amazon.smithy.codegen.core.trace.TracingSymbolProvider
Builder to create a TracingSymbolProvider instance.
Builder() - Constructor for class software.amazon.smithy.codegen.core.ReservedWordSymbolProvider.Builder
 
Builder() - Constructor for class software.amazon.smithy.codegen.core.Symbol.Builder
 
Builder() - Constructor for class software.amazon.smithy.codegen.core.trace.ArtifactDefinitions.Builder
 
Builder() - Constructor for class software.amazon.smithy.codegen.core.trace.ShapeLink.Builder
 
Builder() - Constructor for class software.amazon.smithy.codegen.core.trace.TraceFile.Builder
 
Builder() - Constructor for class software.amazon.smithy.codegen.core.trace.TraceMetadata.Builder
 
Builder() - Constructor for class software.amazon.smithy.codegen.core.trace.TracingSymbolProvider.Builder
 
buildEscaper() - Method in class software.amazon.smithy.codegen.core.ReservedWordSymbolProvider.Builder
Builds a SymbolProvider.Escaper that is used to manually escape Symbols and member names.
buildTraceFile() - Method in class software.amazon.smithy.codegen.core.trace.TracingSymbolProvider
Builds and returns the TracingSymbolProvider's TraceFile.Builder.

C

cache(SymbolProvider) - Static method in interface software.amazon.smithy.codegen.core.SymbolProvider
Decorates a SymbolProvider with a cache and returns the decorated SymbolProvider.
changeStringEnumsToEnumShapes(boolean) - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Changes each compatible string shape with the enum trait to an enum shape.
CodegenContext<S,W extends SymbolWriter<W,?>,I extends SmithyIntegration<S,W,?>> - Interface in software.amazon.smithy.codegen.core
A context object that can be used during code generation and is used by SmithyIntegration.
CodegenDirector<W extends SymbolWriter<W,? extends ImportContainer>,I extends SmithyIntegration<S,W,C>,C extends CodegenContext<S,W,I>,S> - Class in software.amazon.smithy.codegen.core.directed
Performs directed code generation of a DirectedCodegen.
CodegenDirector() - Constructor for class software.amazon.smithy.codegen.core.directed.CodegenDirector
 
CodegenException - Exception in software.amazon.smithy.codegen.core
Thrown when an error occurs during code generation.
CodegenException(String) - Constructor for exception software.amazon.smithy.codegen.core.CodegenException
 
CodegenException(String, Throwable) - Constructor for exception software.amazon.smithy.codegen.core.CodegenException
 
CodegenException(Throwable) - Constructor for exception software.amazon.smithy.codegen.core.CodegenException
 
CodegenWriter<T extends CodegenWriter<T,U>,U extends ImportContainer> - Class in software.amazon.smithy.codegen.core.writer
Deprecated.
prefer SymbolWriter. This will be removed in a future release.
CodegenWriter(DocumentationWriter<T>, U) - Constructor for class software.amazon.smithy.codegen.core.writer.CodegenWriter
Deprecated.
 
CodegenWriterDelegator<T extends CodegenWriter<T,?>> - Class in software.amazon.smithy.codegen.core.writer
Deprecated.
prefer WriterDelegator. This class will be removed in a future release.
CodegenWriterDelegator(FileManifest, SymbolProvider, CodegenWriterFactory<T>) - Constructor for class software.amazon.smithy.codegen.core.writer.CodegenWriterDelegator
Deprecated.
 
CodegenWriterFactory<T extends CodegenWriter<T,?>> - Interface in software.amazon.smithy.codegen.core.writer
Deprecated.
prefer SymbolWriter.Factory. This will be removed in a future release.
column(Integer) - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink.Builder
Sets tags list of a ShapeLink.
COLUMN_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.ShapeLink
 
compareTo(SymbolDependency) - Method in class software.amazon.smithy.codegen.core.SymbolDependency
Dependencies can be sorted based on the natural sort order of the dependencyType, packageName, and finally the version.
compose(ReservedWords...) - Static method in interface software.amazon.smithy.codegen.core.ReservedWords
Composes multiple instance of ReservedWords into a single implementation that delegates to them one after the other.
connectedShapes() - Method in class software.amazon.smithy.codegen.core.directed.Directive
 
context() - Method in class software.amazon.smithy.codegen.core.directed.ContextualDirective
 
ContextualDirective<C extends CodegenContext<S,?,?>,S> - Class in software.amazon.smithy.codegen.core.directed
Directive that contains a CodegenContext.
createContext(CreateContextDirective<S, I>) - Method in interface software.amazon.smithy.codegen.core.directed.DirectedCodegen
Creates the codegen context object.
CreateContextDirective<S,I extends SmithyIntegration<S,?,?>> - Class in software.amazon.smithy.codegen.core.directed
Directive used to create a CodegenContext.
createDedicatedInputsAndOutputs() - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Generates dedicated input and output shapes for every operation if the operation doesn't already have them.
createDedicatedInputsAndOutputs(String, String) - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Generates dedicated input and output shapes for every operation if the operation doesn't already have them.
createSymbolProvider(CreateSymbolProviderDirective<S>) - Method in interface software.amazon.smithy.codegen.core.directed.DirectedCodegen
Create the SymbolProvider used to map shapes to code symbols.
CreateSymbolProviderDirective<S> - Class in software.amazon.smithy.codegen.core.directed
Directive used to create a SymbolProvider.
customize(C) - Method in interface software.amazon.smithy.codegen.core.SmithyIntegration
Allows generators to write additional files, perform additional tasks, and interact directly with a FileManifest used to write files to the plugin's output.
customizeAfterIntegrations(CustomizeDirective<C, S>) - Method in interface software.amazon.smithy.codegen.core.directed.DirectedCodegen
Performs any necessary code generation after all shapes are generated, using the created codegen context object after all integrations have performed customizations.
customizeBeforeIntegrations(CustomizeDirective<C, S>) - Method in interface software.amazon.smithy.codegen.core.directed.DirectedCodegen
Performs any necessary code generation after all shapes are generated, using the created codegen context object before integrations perform customizations.
customizeBeforeShapeGeneration(CustomizeDirective<C, S>) - Method in interface software.amazon.smithy.codegen.core.directed.DirectedCodegen
Performs any necessary code generation before all shapes are generated, using the created codegen context object.
CustomizeDirective<C extends CodegenContext<S,?,?>,S> - Class in software.amazon.smithy.codegen.core.directed
Directive used to perform post-processing code generation.

D

declarationFile(String) - Method in class software.amazon.smithy.codegen.core.Symbol.Builder
Sets the filename of where this symbol is declared.
DECLARE - Enum constant in enum class software.amazon.smithy.codegen.core.SymbolReference.ContextOption
Indicates that the referenced symbol is needed when declaring the symbol.
decorateSymbolProvider(Model, S, SymbolProvider) - Method in interface software.amazon.smithy.codegen.core.SmithyIntegration
Updates the SymbolProvider used when generating code.
definitionFile(String) - Method in class software.amazon.smithy.codegen.core.Symbol.Builder
Sets the filename of where this symbol is defined.
definitions(ArtifactDefinitions) - Method in class software.amazon.smithy.codegen.core.trace.TraceFile.Builder
 
DEFINITIONS_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.TraceFile
 
dependencies(List<SymbolDependency>) - Method in class software.amazon.smithy.codegen.core.Symbol.Builder
Replaces the symbol dependencies of the symbol.
dependencies(SymbolDependencyContainer) - Method in class software.amazon.smithy.codegen.core.Symbol.Builder
Replaces the symbol dependencies of the symbol.
DependencyTracker - Class in software.amazon.smithy.codegen.core
A container for all known dependencies of a generator.
DependencyTracker() - Constructor for class software.amazon.smithy.codegen.core.DependencyTracker
 
dependencyType(String) - Method in class software.amazon.smithy.codegen.core.SymbolDependency.Builder
Sets the type of dependency (for example, "dev", "optional", etc).
directedCodegen(DirectedCodegen<C, S, I>) - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Sets the required DirectedCodegen implementation to invoke.
DirectedCodegen<C extends CodegenContext<S,?,I>,S,I extends SmithyIntegration<S,?,C>> - Interface in software.amazon.smithy.codegen.core.directed
Provides a directed code generation abstraction to make it easier to implement a Smithy code generator for a single service that leverages other abstractions in smithy-codegen-core, including SmithyIntegration, SymbolProvider, CodegenContext, SymbolWriter, and WriterDelegator.
Directive<S> - Class in software.amazon.smithy.codegen.core.directed
Directive classes contain all of the context needed in order to perform the tasks defined in a DirectedCodegen implementation.
DocumentationWriter<T extends software.amazon.smithy.utils.CodeWriter> - Interface in software.amazon.smithy.codegen.core.writer
Deprecated.
prefer DocWriter. This will be removed in a future release.
DocWriter<T extends software.amazon.smithy.utils.AbstractCodeWriter<T>> - Interface in software.amazon.smithy.codegen.core.writer
Deprecated.

E

ENUM - Enum constant in enum class software.amazon.smithy.codegen.core.directed.GenerateEnumDirective.EnumType
 
equals(Object) - Method in class software.amazon.smithy.codegen.core.Symbol
 
equals(Object) - Method in class software.amazon.smithy.codegen.core.SymbolDependency
 
equals(Object) - Method in class software.amazon.smithy.codegen.core.SymbolReference
 
errorTrait() - Method in class software.amazon.smithy.codegen.core.directed.GenerateErrorDirective
Gets the error trait.
escape(String) - Method in class software.amazon.smithy.codegen.core.MappedReservedWords
 
escape(String) - Method in interface software.amazon.smithy.codegen.core.ReservedWords
Escapes a reserved word.
escapeAtSignWithEntity(boolean) - Method in class software.amazon.smithy.codegen.core.writer.JavaStyleDocumentationWriterBuilder
Deprecated.
Sets whether or not the "@" sign is escaped with an HTML entity.
escapeAtSignWithEntity(String) - Static method in class software.amazon.smithy.codegen.core.writer.JavaStyleDocumentationWriterBuilder
Deprecated.
A function used to escape the @ sign of a documentation comment with an HTML entity of &#064;.
escapeClosingChars(String) - Static method in class software.amazon.smithy.codegen.core.writer.JavaStyleDocumentationWriterBuilder
Deprecated.
A function used to escape the closing tokens of a documentation comment.
escapeMemberName(String) - Method in class software.amazon.smithy.codegen.core.ReservedWordSymbolProvider.Escaper
Escapes the given member name if needed.
escapePredicate(BiPredicate<Shape, Symbol>) - Method in class software.amazon.smithy.codegen.core.ReservedWordSymbolProvider.Builder
Sets a predicate that is used to control when a shape + symbol combination should be checked if it's a reserved word.
escapeSymbol(Shape, Symbol) - Method in class software.amazon.smithy.codegen.core.ReservedWordSymbolProvider.Escaper
Escapes the given symbol using the reserved words implementations registered for each component.
expectEnumShape() - Method in class software.amazon.smithy.codegen.core.directed.GenerateEnumDirective
 
expectProperty(String) - Method in class software.amazon.smithy.codegen.core.SymbolReference
Gets a specific additional property or throws if missing.
expectProperty(String, Class<T>) - Method in class software.amazon.smithy.codegen.core.SymbolReference
Gets a specific additional property or throws if missing or if the property is not an instance of the given type.

F

file(String) - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink.Builder
Sets File of a ShapeLink.
FILE_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.ShapeLink
 
fileManifest() - Method in interface software.amazon.smithy.codegen.core.CodegenContext
 
fileManifest() - Method in class software.amazon.smithy.codegen.core.directed.ContextualDirective
 
fileManifest() - Method in class software.amazon.smithy.codegen.core.directed.CreateContextDirective
 
fileManifest(FileManifest) - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Sets the required file manifest used to write files to disk.
filenameReservedWords(ReservedWords) - Method in class software.amazon.smithy.codegen.core.ReservedWordSymbolProvider.Builder
Sets the reserved word implementation for file names.
flushWriters() - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriterDelegator
Deprecated.
Writes each pending CodegenWriter to the FileManifest.
flushWriters() - Method in class software.amazon.smithy.codegen.core.WriterDelegator
Writes each pending SymbolWriter to the FileManifest.
fromNode(Node) - Static method in class software.amazon.smithy.codegen.core.trace.ArtifactDefinitions
Converts an ObjectNode that represents the definitions section of the trace file into a types maps and tags map.
fromNode(Node) - Static method in class software.amazon.smithy.codegen.core.trace.ShapeLink
Instantiates ShapeLink instance variables by extracting data from an ObjectNode.
fromNode(Node) - Static method in class software.amazon.smithy.codegen.core.trace.TraceFile
Converts ObjectNode into TraceFile.
fromNode(Node) - Static method in class software.amazon.smithy.codegen.core.trace.TraceMetadata
Instantiates TraceMetadata instance variables using an ObjectNode that contains the artifact section of the trace file.

G

gatherDependencies(Stream<SymbolDependency>) - Static method in class software.amazon.smithy.codegen.core.SymbolDependency
Gets a mapping of all dependencies used by the provided symbols.
gatherDependencies(Stream<SymbolDependency>, BinaryOperator<SymbolDependency>) - Static method in class software.amazon.smithy.codegen.core.SymbolDependency
Gets a mapping of all dependencies used by the provided symbols.
GenerateEnumDirective<C extends CodegenContext<S,?,?>,S> - Class in software.amazon.smithy.codegen.core.directed
Directive used to generate an enum shape or enum string shape.
GenerateEnumDirective.EnumType - Enum Class in software.amazon.smithy.codegen.core.directed
Represents the type of enum to generate.
generateEnumShape(GenerateEnumDirective<C, S>) - Method in interface software.amazon.smithy.codegen.core.directed.DirectedCodegen
Generates the code needed for an enum shape, whether it's a string shape marked with the enum trait, or a proper enum shape introduced in Smithy IDL 2.0.
generateError(GenerateErrorDirective<C, S>) - Method in interface software.amazon.smithy.codegen.core.directed.DirectedCodegen
Generates the code needed for an error structure.
GenerateErrorDirective<C extends CodegenContext<S,?,?>,S> - Class in software.amazon.smithy.codegen.core.directed
Directive used to generate an error.
GenerateIntEnumDirective<C extends CodegenContext<S,?,?>,S> - Class in software.amazon.smithy.codegen.core.directed
Directive used to generate an intEnum.
generateIntEnumShape(GenerateIntEnumDirective<C, S>) - Method in interface software.amazon.smithy.codegen.core.directed.DirectedCodegen
Generates the code needed for an intEnum shape.
generateResource(GenerateResourceDirective<C, S>) - Method in interface software.amazon.smithy.codegen.core.directed.DirectedCodegen
Generates the code needed for a resource shape.
GenerateResourceDirective<C extends CodegenContext<S,?,?>,S> - Class in software.amazon.smithy.codegen.core.directed
Directive used to generate a resource.
generateService(GenerateServiceDirective<C, S>) - Method in interface software.amazon.smithy.codegen.core.directed.DirectedCodegen
Generates the code needed for a service shape.
GenerateServiceDirective<C extends CodegenContext<S,?,?>,S> - Class in software.amazon.smithy.codegen.core.directed
Directive used to generate a service.
generateStructure(GenerateStructureDirective<C, S>) - Method in interface software.amazon.smithy.codegen.core.directed.DirectedCodegen
Generates the code needed for a structure shape.
GenerateStructureDirective<C extends CodegenContext<S,?,?>,S> - Class in software.amazon.smithy.codegen.core.directed
Directive used to generate a structure.
generateUnion(GenerateUnionDirective<C, S>) - Method in interface software.amazon.smithy.codegen.core.directed.DirectedCodegen
Generates the code needed for a union shape.
GenerateUnionDirective<C extends CodegenContext<S,?,?>,S> - Class in software.amazon.smithy.codegen.core.directed
Directive used to generate a union.
getAlias() - Method in class software.amazon.smithy.codegen.core.SymbolReference
Gets the alias to use when referring to the Symbol.
getArtifactDefinitions() - Method in class software.amazon.smithy.codegen.core.trace.TraceFile
Gets this TraceFile's Definitions.
getByName(String) - Method in class software.amazon.smithy.codegen.core.DependencyTracker
Gets the first found dependency by name.
getByName(String, String) - Method in class software.amazon.smithy.codegen.core.DependencyTracker
Gets the first found dependency by name and dependency type.
getByProperty(String) - Method in class software.amazon.smithy.codegen.core.DependencyTracker
Gets a list of matching dependencies that contain a property named property.
getByProperty(String, Object) - Method in class software.amazon.smithy.codegen.core.DependencyTracker
Gets a list of matching dependencies that contain a property named property with a value of value.
getByType(String) - Method in class software.amazon.smithy.codegen.core.DependencyTracker
Gets a list of matching dependencies that have a dependency type matching dependencyType.
getColumn() - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink
Gets this ShapeLink's column number in an optional container.
getDeclarationFile() - Method in class software.amazon.smithy.codegen.core.Symbol
Gets the location/filename in which the symbol is declared.
getDefinitionFile() - Method in class software.amazon.smithy.codegen.core.Symbol
Gets the location/filename in which the symbol is defined.
getDependencies() - Method in class software.amazon.smithy.codegen.core.DependencyTracker
 
getDependencies() - Method in class software.amazon.smithy.codegen.core.Symbol
 
getDependencies() - Method in class software.amazon.smithy.codegen.core.SymbolDependency
 
getDependencies() - Method in interface software.amazon.smithy.codegen.core.SymbolDependencyContainer
Gets the list of dependencies that this object introduces.
getDependencies() - Method in class software.amazon.smithy.codegen.core.SymbolReference
 
getDependencies() - Method in class software.amazon.smithy.codegen.core.SymbolWriter
 
getDependencies() - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriter
Deprecated.
 
getDependencies() - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriterDelegator
Deprecated.
Gets all of the dependencies that have been registered in writers created by the CodegenWriterDelegator.
getDependencies() - Method in class software.amazon.smithy.codegen.core.writer.SymbolWriter
Deprecated.
 
getDependencies() - Method in class software.amazon.smithy.codegen.core.WriterDelegator
Gets all of the dependencies that have been registered in writers created by the WriterDelegator.
getDependencyType() - Method in class software.amazon.smithy.codegen.core.SymbolDependency
Gets the type of dependency (for example, "dev", "optional", etc).
getDocumentationWriter() - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriter
Deprecated.
Gets the documentation writer.
getDocumentationWriter() - Method in class software.amazon.smithy.codegen.core.writer.SymbolWriter
Deprecated.
Gets the documentation writer.
getEnumTrait() - Method in class software.amazon.smithy.codegen.core.directed.GenerateEnumDirective
Gets the EnumTrait of the shape.
getEnumType() - Method in class software.amazon.smithy.codegen.core.directed.GenerateEnumDirective
Gets the type of enum being generated, whether it's a string shape marked with the enum trait or, in Smithy IDL 2.0, an actual enum shape.
getFile() - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink
Gets this ShapeLink's file in an optional container.
getFullName() - Method in class software.amazon.smithy.codegen.core.Symbol
Gets the full name of the symbol.
getHomepage() - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata
Gets this TraceMetadata's Homepage in an Optional container.
getId() - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink
Gets this ShapeLink's id.
getId() - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata
Gets this TraceMetadata's id.
getImportContainer() - Method in class software.amazon.smithy.codegen.core.SymbolWriter
Gets the import container associated with the writer.
getImportContainer() - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriter
Deprecated.
Gets the import container associated with the writer.
getImportContainer() - Method in class software.amazon.smithy.codegen.core.writer.SymbolWriter
Deprecated.
Gets the import container associated with the writer.
getLine() - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink
Gets this ShapeLink's line number in an optional container.
getMetadata() - Method in class software.amazon.smithy.codegen.core.trace.TraceFile
Gets this TraceFile's TraceMetadata.
getName() - Method in class software.amazon.smithy.codegen.core.Symbol
Gets the unqualified name of the symbol, that is, a name without namespace.
getNamespace() - Method in class software.amazon.smithy.codegen.core.Symbol
Provides the namespace of the symbol or "" if empty.
getNamespaceDelimiter() - Method in class software.amazon.smithy.codegen.core.Symbol
Provides the namespace delimiter of the symbol or "" if empty.
getOptions() - Method in class software.amazon.smithy.codegen.core.SymbolReference
Gets all of the reference options.
getOrderedShapes() - Method in class software.amazon.smithy.codegen.core.TopologicalIndex
Gets all reverse-topologically ordered shapes, including members.
getPackageName() - Method in class software.amazon.smithy.codegen.core.SymbolDependency
Gets the package name referenced by the dependency.
getProperties() - Method in class software.amazon.smithy.codegen.core.SymbolReference
Gets the additional properties of the object.
getProperty(String) - Method in class software.amazon.smithy.codegen.core.SymbolReference
Gets a specific property if present.
getProperty(String, Class<T>) - Method in class software.amazon.smithy.codegen.core.SymbolReference
Gets an additional property of a specific type.
getRecursiveClosure(ToShapeId) - Method in class software.amazon.smithy.codegen.core.TopologicalIndex
Gets the recursive closure of a given shape represented as PathFinder.Path objects.
getRecursiveShapes() - Method in class software.amazon.smithy.codegen.core.TopologicalIndex
Gets all shapes that have edges that are part of a recursive closure, including container shapes (list/set/map/structure/union) and members.
getReferences() - Method in class software.amazon.smithy.codegen.core.Symbol
Gets the list of symbols that are referenced by this symbol.
getShapes() - Method in class software.amazon.smithy.codegen.core.trace.TraceFile
Gets this TraceFile's Shapes map.
getSmithyTrace() - Method in class software.amazon.smithy.codegen.core.trace.TraceFile
Gets this TraceFile's smithyTrace.
getSymbol() - Method in class software.amazon.smithy.codegen.core.SymbolReference
Gets the referenced symbol.
getSymbols() - Method in class software.amazon.smithy.codegen.core.Symbol
 
getSymbols() - Method in interface software.amazon.smithy.codegen.core.SymbolContainer
Returns any Symbol objects contained in the object.
getSymbols() - Method in class software.amazon.smithy.codegen.core.SymbolReference
 
getTags() - Method in class software.amazon.smithy.codegen.core.trace.ArtifactDefinitions
Gets this Definition's Tags Map.
getTags() - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink
Gets this ShapeLink's tags list.
getTimestamp() - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata
Gets this TraceMetadata's timestamp.
getType() - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink
Gets this ShapeLink's type.
getType() - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata
Gets this TraceMetadata's type.
getTypes() - Method in class software.amazon.smithy.codegen.core.trace.ArtifactDefinitions
Gets this Definition's Types Map.
getTypeVersion() - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata
Gets this TraceMetadata's TypeVersion in an Optional container.
getVersion() - Method in class software.amazon.smithy.codegen.core.SymbolDependency
Gets the version string of the dependency.
getVersion() - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata
Gets this TraceMetadata's version (for example, the AWS SDK release number).
getWriters() - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriterDelegator
Deprecated.
Returns an immutable Map of created CodegenWriters.
getWriters() - Method in class software.amazon.smithy.codegen.core.WriterDelegator
Returns an immutable Map of created SymbolWriters.

H

hashCode() - Method in class software.amazon.smithy.codegen.core.Symbol
 
hashCode() - Method in class software.amazon.smithy.codegen.core.SymbolDependency
 
hashCode() - Method in class software.amazon.smithy.codegen.core.SymbolReference
 
hasOption(SymbolReference.Option) - Method in class software.amazon.smithy.codegen.core.SymbolReference
Checks if the given option is set on the symbol.
homepage(String) - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata.Builder
Sets this builder's homepage.
HOMEPAGE_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.TraceMetadata
 

I

id(String) - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink.Builder
 
id(String) - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata.Builder
 
ID_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.ShapeLink
 
ID_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.TraceMetadata
 
identity() - Static method in interface software.amazon.smithy.codegen.core.ReservedWords
Creates a reserved word implementation that does not modify words.
ImportContainer - Interface in software.amazon.smithy.codegen.core
Contains the imports associated with a specific file.
ImportContainer - Interface in software.amazon.smithy.codegen.core.writer
Deprecated.
importSymbol(Symbol) - Method in interface software.amazon.smithy.codegen.core.ImportContainer
Adds an import for the given symbol if and only if the "namespace" of the provided Symbol differs from the "namespace" associated with the ImportContainer.
importSymbol(Symbol, String) - Method in interface software.amazon.smithy.codegen.core.ImportContainer
Adds an import for the given symbol if and only if the "namespace" of the provided Symbol differs from the "namespace" associated with the ImportContainer.
importSymbol(Symbol, String) - Method in interface software.amazon.smithy.codegen.core.writer.ImportContainer
Deprecated.
Adds an import for the given symbol if and only if the "namespace" of the provided Symbol differs from the "namespace" associated with the ImportContainer.
inputEventStreamOperations() - Method in class software.amazon.smithy.codegen.core.directed.GenerateServiceDirective
Get a map of operations that use an event stream in their input.
integrationClass(Class<I>) - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Sets the required class used for SmithyIntegrations.
integrationClassLoader(ClassLoader) - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Sets a custom class loader for finding implementations of SmithyIntegration.
integrationFinder(Supplier<Iterable<I>>) - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Sets a custom implementation for finding SmithyIntegrations.
integrations() - Method in interface software.amazon.smithy.codegen.core.CodegenContext
 
integrations() - Method in class software.amazon.smithy.codegen.core.directed.CreateContextDirective
 
interceptors(C) - Method in interface software.amazon.smithy.codegen.core.SmithyIntegration
Gets a list of CodeInterceptors to register with the AbstractCodeWriters created by the code generator.
isEventStream() - Method in class software.amazon.smithy.codegen.core.directed.GenerateUnionDirective
Check if this is an event stream union.
isInputShape() - Method in class software.amazon.smithy.codegen.core.directed.GenerateStructureDirective
Check if this is a shape used exclusively for input.
isOutputShape() - Method in class software.amazon.smithy.codegen.core.directed.GenerateStructureDirective
Check if this is a shape used exclusively for output.
isRecursive(ToShapeId) - Method in class software.amazon.smithy.codegen.core.TopologicalIndex
Checks if the given shape has edges with recursive references.
isReserved(String) - Method in class software.amazon.smithy.codegen.core.MappedReservedWords
 
isReserved(String) - Method in interface software.amazon.smithy.codegen.core.ReservedWords
Checks if the given word is reserved.

J

JavaStyleDocumentationWriterBuilder - Class in software.amazon.smithy.codegen.core.writer
Deprecated.
this class uses CodeWriter, which is deprecated.
JavaStyleDocumentationWriterBuilder() - Constructor for class software.amazon.smithy.codegen.core.writer.JavaStyleDocumentationWriterBuilder
Deprecated.
 

L

line(Integer) - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink.Builder
Sets line of a ShapeLink.
LINE_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.ShapeLink
 
loadCaseInsensitiveWords(URL) - Method in class software.amazon.smithy.codegen.core.ReservedWordsBuilder
Load a list of case-insensitive, line-delimited reserved words from a file.
loadCaseInsensitiveWords(URL, Function<String, String>) - Method in class software.amazon.smithy.codegen.core.ReservedWordsBuilder
Load a list of case-insensitive, line-delimited reserved words from a file.
loadWords(URL) - Method in class software.amazon.smithy.codegen.core.ReservedWordsBuilder
Load a list of case-sensitive, line-delimited reserved words from a file.
loadWords(URL, Function<String, String>) - Method in class software.amazon.smithy.codegen.core.ReservedWordsBuilder
Load a list of case-sensitive, line-delimited reserved words from a file.

M

MappedReservedWords - Class in software.amazon.smithy.codegen.core
A reserved words implementation that maps known words to other words.
MappedReservedWords(Map<String, String>, Map<String, String>) - Constructor for class software.amazon.smithy.codegen.core.MappedReservedWords
 
MappedReservedWords.Builder - Class in software.amazon.smithy.codegen.core
Builder to create a new MappedReservedWords instance.
mappingFunction(Function<String, String>) - Method in class software.amazon.smithy.codegen.core.writer.JavaStyleDocumentationWriterBuilder
Deprecated.
Sets a custom mapping function to use when filtering documentation.
memberReservedWords(ReservedWords) - Method in class software.amazon.smithy.codegen.core.ReservedWordSymbolProvider.Builder
Sets the reserved word implementation for members.
metadata(TraceMetadata) - Method in class software.amazon.smithy.codegen.core.trace.TraceFile.Builder
 
metadata(TraceMetadata) - Method in class software.amazon.smithy.codegen.core.trace.TracingSymbolProvider.Builder
Sets this Builder's TraceMetadata.
METADATA_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.TraceFile
 
model() - Method in interface software.amazon.smithy.codegen.core.CodegenContext
 
model() - Method in class software.amazon.smithy.codegen.core.directed.Directive
 
model(Model) - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Sets the required model to generate from.

N

name() - Method in interface software.amazon.smithy.codegen.core.SmithyIntegration
Gets the name of the integration.
name(String) - Method in class software.amazon.smithy.codegen.core.Symbol.Builder
Sets the unqualified name of the symbol.
namedDocumentationSection(String) - Method in class software.amazon.smithy.codegen.core.writer.JavaStyleDocumentationWriterBuilder
Deprecated.
Sets a specific named section to use when writing documentation.
nameReservedWords(ReservedWords) - Method in class software.amazon.smithy.codegen.core.ReservedWordSymbolProvider.Builder
Sets the reserved word implementation for names (structures names, class names, etc.).
namespace(String, String) - Method in class software.amazon.smithy.codegen.core.Symbol.Builder
Sets the namespace and namespace delimiter of the symbol.
namespaceReservedWords(ReservedWords) - Method in class software.amazon.smithy.codegen.core.ReservedWordSymbolProvider.Builder
Sets the reserved word implementation for namespace names.

O

of(Model) - Static method in class software.amazon.smithy.codegen.core.TopologicalIndex
Creates a new TopologicalIndex.
operations() - Method in class software.amazon.smithy.codegen.core.directed.Directive
Gets a set of all operation shapes in the service, sorted by name.
options(Set<SymbolReference.Option>) - Method in class software.amazon.smithy.codegen.core.SymbolReference.Builder
Replaces the Set of Options to the SymbolReference.
options(SymbolReference.Option...) - Method in class software.amazon.smithy.codegen.core.SymbolReference.Builder
Replaces the array of Options in the SymbolReference.
outputEventStreamOperations() - Method in class software.amazon.smithy.codegen.core.directed.GenerateServiceDirective
Get a map of operations that use an event stream in their output.

P

packageName(String) - Method in class software.amazon.smithy.codegen.core.SymbolDependency.Builder
Sets the package name of the dependency.
performDefaultCodegenTransforms() - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
preprocessModel(Model, S) - Method in interface software.amazon.smithy.codegen.core.SmithyIntegration
Preprocess the model before code generation.
priority() - Method in interface software.amazon.smithy.codegen.core.SmithyIntegration
Gets the priority ordering relative to the topologically ordered integration graph determined by SmithyIntegration.runBefore() and SmithyIntegration.runAfter().
properties(Map<String, Object>) - Method in class software.amazon.smithy.codegen.core.SymbolReference.Builder
Replaces all of the custom properties.
put(String, String) - Method in class software.amazon.smithy.codegen.core.MappedReservedWords.Builder
Add a new reserved words.
put(String, String) - Method in class software.amazon.smithy.codegen.core.ReservedWordsBuilder
Add a new reserved words.
putCaseInsensitive(String, String) - Method in class software.amazon.smithy.codegen.core.MappedReservedWords.Builder
Add a new case-insensitive reserved word that converts the given reserved word to the given conversion string.
putProperty(String, Object) - Method in class software.amazon.smithy.codegen.core.SymbolReference.Builder
Sets a specific custom property.

R

references(List<SymbolReference>) - Method in class software.amazon.smithy.codegen.core.Symbol.Builder
Replaces the symbol references to the symbol.
relativize(String) - Method in class software.amazon.smithy.codegen.core.Symbol
Creates a relativized Symbol for the given namespace.
removeProperty(String) - Method in class software.amazon.smithy.codegen.core.SymbolReference.Builder
Removes a specific custom property.
ReservedWords - Interface in software.amazon.smithy.codegen.core
Determines what is reserved and escapes reserved words.
ReservedWordsBuilder - Class in software.amazon.smithy.codegen.core
Builds a ReservedWords implementation from explicit mappings and from line-delimited files that contain reserved words.
ReservedWordsBuilder() - Constructor for class software.amazon.smithy.codegen.core.ReservedWordsBuilder
 
ReservedWordSymbolProvider - Class in software.amazon.smithy.codegen.core
Decorates a SymbolProvider by passing values through context specific ReservedWords implementations.
ReservedWordSymbolProvider.Builder - Class in software.amazon.smithy.codegen.core
Builder to build a ReservedWordSymbolProvider.
ReservedWordSymbolProvider.Escaper - Class in software.amazon.smithy.codegen.core
Uses to manually escape Symbols and member names.
run() - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Finalizes the Runner and performs directed code generation.
runAfter() - Method in interface software.amazon.smithy.codegen.core.SmithyIntegration
Gets the name of the integrations that this integration must come after.
runBefore() - Method in interface software.amazon.smithy.codegen.core.SmithyIntegration
Gets the names of integrations that this integration must come before.

S

service() - Method in class software.amazon.smithy.codegen.core.directed.Directive
 
service(ShapeId) - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Sets the required service being generated.
serviceTitle() - Method in class software.amazon.smithy.codegen.core.directed.GenerateServiceDirective
Gets the TitleTrait value of the service if present, otherwise returns the Symbol.getName() value of the service.
serviceTitle(String) - Method in class software.amazon.smithy.codegen.core.directed.GenerateServiceDirective
Attempts to get the title of service from the model, returning the fallback value if the service does not have a TitleTrait.
setAutomaticSeparator(String) - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriterDelegator
Deprecated.
Sets the automatic separator that is written to a CodegenWriter each time the writer is reused.
setAutomaticSeparator(String) - Method in class software.amazon.smithy.codegen.core.WriterDelegator
Sets the automatic separator that is written to a SymbolWriter each time the writer is reused.
setInterceptors(List<? extends CodeInterceptor<? extends CodeSection, W>>) - Method in class software.amazon.smithy.codegen.core.WriterDelegator
Sets the list of code interceptors to registered with each newly created writer.
setRelativizeSymbols(String) - Method in class software.amazon.smithy.codegen.core.SymbolWriter
Sets a string used to relativize Symbols formatted using the default W implementation used by SymbolWriter in the current state.
setRelativizeSymbols(String) - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriter
Deprecated.
Sets a string used to relativize Symbols formatted using the default T implementation used by CodegenWriter in the current state.
setRelativizeSymbols(String) - Method in class software.amazon.smithy.codegen.core.writer.SymbolWriter
Deprecated.
Sets a string used to relativize Symbols formatted using the default T implementation used by CodegenWriter in the current state.
setTimestampAsNow() - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata.Builder
Sets the timestamp as the current time in RFC 3339 format.
settings() - Method in interface software.amazon.smithy.codegen.core.CodegenContext
 
settings() - Method in class software.amazon.smithy.codegen.core.directed.Directive
 
settings(Class<S>, Node) - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Sets the required settings object used for code generation using a Node.
settings(S) - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Sets the required settings object used for code generation.
setTraceMetadataAsDefault(String) - Method in class software.amazon.smithy.codegen.core.trace.TracingSymbolProvider.Builder
Sets the Builder's TraceMetadata based on the given type and default values for other required fields.
shape() - Method in class software.amazon.smithy.codegen.core.directed.ShapeDirective
Gets the shape being generated.
ShapeDirective<T extends software.amazon.smithy.model.shapes.Shape,C extends CodegenContext<S,?,?>,S> - Class in software.amazon.smithy.codegen.core.directed
Directive used to generate a specific shape.
ShapeLink - Class in software.amazon.smithy.codegen.core.trace
Class that defines a link between the Smithy Shape and the artifact that it produced.
ShapeLink.Builder - Class in software.amazon.smithy.codegen.core.trace
 
shapeLinkCreator(BiFunction<Shape, Symbol, List<ShapeLink>>) - Method in class software.amazon.smithy.codegen.core.trace.TracingSymbolProvider.Builder
Sets this Builder's shapeLinkCreator.
shapes(Map<ShapeId, List<ShapeLink>>) - Method in class software.amazon.smithy.codegen.core.trace.TraceFile.Builder
 
SHAPES_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.TraceFile
 
simplifyModelForServiceCodegen(Model, ShapeId, ModelTransformer) - Static method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Simplifies a Smithy model for code generation of a single service.
SMITHY_TRACE_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.TraceFile
 
SMITHY_TRACE_VERSION - Static variable in class software.amazon.smithy.codegen.core.trace.TraceFile
 
SmithyIntegration<S,W extends SymbolWriter<W,?>,C extends CodegenContext<S,W,?>> - Interface in software.amazon.smithy.codegen.core
This interface provides the base concept of an "Integration" to Smithy code generators.
smithyTrace(String) - Method in class software.amazon.smithy.codegen.core.trace.TraceFile.Builder
 
software.amazon.smithy.codegen.core - package software.amazon.smithy.codegen.core
Defines abstractions for implementing Smithy model code generation.
software.amazon.smithy.codegen.core.directed - package software.amazon.smithy.codegen.core.directed
 
software.amazon.smithy.codegen.core.trace - package software.amazon.smithy.codegen.core.trace
Defines abstractions for implementing Smithy model trace file generation.
software.amazon.smithy.codegen.core.writer - package software.amazon.smithy.codegen.core.writer
This package is deprecated and will be removed in a future release.
sort(Iterable<I>) - Static method in interface software.amazon.smithy.codegen.core.SmithyIntegration
Topologically sorts a list of integrations based on priority, runBefore, and runAfter, and integration names.
sortMembers() - Method in class software.amazon.smithy.codegen.core.directed.CodegenDirector
Sorts all members of the model prior to codegen.
STRING - Enum constant in enum class software.amazon.smithy.codegen.core.directed.GenerateEnumDirective.EnumType
A string shape marked with the enum trait is being generated.
supportedProtocols() - Method in class software.amazon.smithy.codegen.core.directed.CreateContextDirective
Get a map of supported protocols on the service shape in the form of shape ID to the definition of the trait.
symbol() - Method in class software.amazon.smithy.codegen.core.directed.ShapeDirective
Gets the symbol created for the shape.
symbol(Symbol) - Method in class software.amazon.smithy.codegen.core.SymbolReference.Builder
Sets the Symbol referenced by the SymbolReference.
Symbol - Class in software.amazon.smithy.codegen.core
A "symbol" is created by a SymbolProvider, and represents the qualified name of a type in a target programming language.
Symbol.Builder - Class in software.amazon.smithy.codegen.core
Builds a Symbol.
SymbolContainer - Interface in software.amazon.smithy.codegen.core
A holder for Symbol objects.
SymbolDependency - Class in software.amazon.smithy.codegen.core
Represents a dependency that is introduced by a Symbol.
SymbolDependency.Builder - Class in software.amazon.smithy.codegen.core
Builds a SymbolDependency.
SymbolDependencyContainer - Interface in software.amazon.smithy.codegen.core
A container for SymbolDependency objects.
symbolProvider() - Method in interface software.amazon.smithy.codegen.core.CodegenContext
 
symbolProvider() - Method in class software.amazon.smithy.codegen.core.directed.ContextualDirective
 
symbolProvider() - Method in class software.amazon.smithy.codegen.core.directed.CreateContextDirective
 
symbolProvider(SymbolProvider) - Method in class software.amazon.smithy.codegen.core.ReservedWordSymbolProvider.Builder
Sets the delegate symbol provider.
symbolProvider(SymbolProvider) - Method in class software.amazon.smithy.codegen.core.trace.TracingSymbolProvider.Builder
Sets this Builder's SymbolProvider.
SymbolProvider - Interface in software.amazon.smithy.codegen.core
Provides Symbol objects for shapes.
SymbolReference - Class in software.amazon.smithy.codegen.core
Represents a reference from a Symbol to another Symbol.
SymbolReference(Symbol, Map<String, Object>, SymbolReference.Option...) - Constructor for class software.amazon.smithy.codegen.core.SymbolReference
 
SymbolReference(Symbol, SymbolReference.Option...) - Constructor for class software.amazon.smithy.codegen.core.SymbolReference
 
SymbolReference.Builder - Class in software.amazon.smithy.codegen.core
Builds a SymbolReference.
SymbolReference.ContextOption - Enum Class in software.amazon.smithy.codegen.core
Options used to control the context of when the symbol reference is needed.
SymbolReference.Option - Interface in software.amazon.smithy.codegen.core
Top-level interface for all SymbolReference options.
SymbolWriter<W extends SymbolWriter<W,I>,I extends ImportContainer> - Class in software.amazon.smithy.codegen.core
A SymbolWriter is a specialized AbstractCodeWriter that makes it easier to implement code generation that utilizes Symbols and SymbolDependency values.
SymbolWriter<T extends SymbolWriter<T,U>,U extends ImportContainer> - Class in software.amazon.smithy.codegen.core.writer
Deprecated.
SymbolWriter(I) - Constructor for class software.amazon.smithy.codegen.core.SymbolWriter
 
SymbolWriter(DocWriter<T>, U) - Constructor for class software.amazon.smithy.codegen.core.writer.SymbolWriter
Deprecated.
 
SymbolWriter.Factory<W extends SymbolWriter<W,? extends ImportContainer>> - Interface in software.amazon.smithy.codegen.core
Factory used to create a SymbolWriter.

T

tags(List<String>) - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink.Builder
Sets tags list of a ShapeLink.
tags(Map<String, String>) - Method in class software.amazon.smithy.codegen.core.trace.ArtifactDefinitions.Builder
 
TAGS_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.ArtifactDefinitions
 
TAGS_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.ShapeLink
 
timestamp(String) - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata.Builder
 
TIMESTAMP_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.TraceMetadata
 
toBuilder() - Method in class software.amazon.smithy.codegen.core.Symbol
 
toBuilder() - Method in class software.amazon.smithy.codegen.core.SymbolDependency
 
toBuilder() - Method in class software.amazon.smithy.codegen.core.SymbolReference
 
toBuilder() - Method in class software.amazon.smithy.codegen.core.trace.ArtifactDefinitions
Take this object and create a builder that contains all of the current property values of this object.
toBuilder() - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink
Take this object and create a builder that contains all of the current property values of this object.
toBuilder() - Method in class software.amazon.smithy.codegen.core.trace.TraceFile
Take this object and create a builder that contains all of the current property values of this object.
toBuilder() - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata
Take this object and create a builder that contains all of the current property values of this object.
toMemberName(MemberShape) - Method in class software.amazon.smithy.codegen.core.ReservedWordSymbolProvider
 
toMemberName(MemberShape) - Method in interface software.amazon.smithy.codegen.core.SymbolProvider
Converts a member shape to a member/property name of a containing data structure.
toMemberName(MemberShape) - Method in class software.amazon.smithy.codegen.core.trace.TracingSymbolProvider
 
toNode() - Method in class software.amazon.smithy.codegen.core.trace.ArtifactDefinitions
Converts the types and tags Maps into a single ObjectNode.
toNode() - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink
Converts instance variables into an ObjectNode for writing out a ShapeLink.
toNode() - Method in class software.amazon.smithy.codegen.core.trace.TraceFile
Converts TraceFile instance variables into an ObjectNode.
toNode() - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata
Converts the metadata contained in TraceMetadata's variables into an ObjectNode.
TopologicalIndex - Class in software.amazon.smithy.codegen.core
Creates a reverse-topological ordering of shapes.
TopologicalIndex(Model) - Constructor for class software.amazon.smithy.codegen.core.TopologicalIndex
 
toReference(String, SymbolReference.Option...) - Method in class software.amazon.smithy.codegen.core.Symbol
Converts the symbol to a SymbolReference using the given alias.
toReferencedSymbol(String) - Method in class software.amazon.smithy.codegen.core.Symbol
Converts the symbol to a Symbol that refers to this Symbol using a SymbolReference.
toReferencedSymbolBuilder(String) - Method in class software.amazon.smithy.codegen.core.Symbol
Converts the symbol to a Symbol.Builder that refers to this Symbol using a SymbolReference via an alias.
toString() - Method in interface software.amazon.smithy.codegen.core.ImportContainer
Implementations must implement a custom toString method that converts the collected imports to code that can be written to a CodeWriter.
toString() - Method in class software.amazon.smithy.codegen.core.Symbol
 
toString() - Method in class software.amazon.smithy.codegen.core.SymbolDependency
 
toString() - Method in class software.amazon.smithy.codegen.core.SymbolReference
 
toString() - Method in interface software.amazon.smithy.codegen.core.writer.ImportContainer
Deprecated.
Implementations must implement a custom toString method that converts the collected imports to code that can be written to a CodeWriter.
toSymbol(Shape) - Method in class software.amazon.smithy.codegen.core.ReservedWordSymbolProvider
 
toSymbol(Shape) - Method in interface software.amazon.smithy.codegen.core.SymbolProvider
Gets the symbol to define for the given shape.
toSymbol(Shape) - Method in class software.amazon.smithy.codegen.core.trace.TracingSymbolProvider
Converts a shape into a symbol by calling the toSymbol method of the SymbolProvider used to construct this TracingSymbolProvider.
TraceFile - Class in software.amazon.smithy.codegen.core.trace
Class that represents the contents of a Smithy trace file.
TraceFile.Builder - Class in software.amazon.smithy.codegen.core.trace
Builder for constructing TraceFile's from scratch.
TraceMetadata - Class in software.amazon.smithy.codegen.core.trace
Class that defines information a code-generated artifact.
TraceMetadata.Builder - Class in software.amazon.smithy.codegen.core.trace
 
TracingSymbolProvider - Class in software.amazon.smithy.codegen.core.trace
Decorates a SymbolProvider with a TraceFile.Builder and adds a ShapeLink object to the builder on each call to toSymbol.
TracingSymbolProvider.Builder - Class in software.amazon.smithy.codegen.core.trace
Builder to create a TracingSymbolProvider instance.
type(String) - Method in class software.amazon.smithy.codegen.core.trace.ShapeLink.Builder
 
type(String) - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata.Builder
 
TYPE_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.ArtifactDefinitions
 
TYPE_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.ShapeLink
 
TYPE_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.TraceMetadata
 
TYPE_VERSION_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.TraceMetadata
 
types(Map<String, String>) - Method in class software.amazon.smithy.codegen.core.trace.ArtifactDefinitions.Builder
 
typeVersion(String) - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata.Builder
Sets this builder's typeVersion.

U

USE - Enum constant in enum class software.amazon.smithy.codegen.core.SymbolReference.ContextOption
Indicates that the referenced symbol is needed when importing/using the symbol.
useFileWriter(String, String, Consumer<T>) - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriterDelegator
Deprecated.
Gets a previously created writer or creates a new one if needed.
useFileWriter(String, String, Consumer<W>) - Method in class software.amazon.smithy.codegen.core.WriterDelegator
Gets a previously created writer or creates a new one if needed.
useFileWriter(String, Consumer<T>) - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriterDelegator
Deprecated.
Gets a previously created CodegenWriter or creates a new one if needed.
useFileWriter(String, Consumer<W>) - Method in class software.amazon.smithy.codegen.core.WriterDelegator
Gets a previously created SymbolWriter or creates a new one if needed.
useShapeWriter(Shape, Consumer<T>) - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriterDelegator
Deprecated.
Gets or creates a writer for a Shape by converting the Shape to a Symbol.
useShapeWriter(Shape, Consumer<W>) - Method in class software.amazon.smithy.codegen.core.WriterDelegator
Gets or creates a writer for a Shape by converting the Shape to a Symbol.

V

validateModel(Model) - Method in class software.amazon.smithy.codegen.core.trace.TraceFile
Parses model and determines whether the trace file object meets the specs of the model by checking if the trace file contains all the ShapeIds in the model and the model contains all the ShapeIDs in the trace file.
valueOf(String) - Static method in enum class software.amazon.smithy.codegen.core.directed.GenerateEnumDirective.EnumType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class software.amazon.smithy.codegen.core.SymbolReference.ContextOption
Returns the enum constant of this class with the specified name.
values() - Static method in enum class software.amazon.smithy.codegen.core.directed.GenerateEnumDirective.EnumType
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.codegen.core.SymbolReference.ContextOption
Returns an array containing the constants of this enum class, in the order they are declared.
version(String) - Method in class software.amazon.smithy.codegen.core.SymbolDependency.Builder
Sets the version string of the dependency.
version(String) - Method in class software.amazon.smithy.codegen.core.trace.TraceMetadata.Builder
 
VERSION_TEXT - Static variable in class software.amazon.smithy.codegen.core.trace.TraceMetadata
 

W

writeDocs(Runnable) - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriter
Deprecated.
Writes documentation comments.
writeDocs(Runnable) - Method in class software.amazon.smithy.codegen.core.writer.SymbolWriter
Deprecated.
Writes documentation comments.
writeDocs(String) - Method in class software.amazon.smithy.codegen.core.writer.CodegenWriter
Deprecated.
Writes documentation comments from a string.
writeDocs(String) - Method in class software.amazon.smithy.codegen.core.writer.SymbolWriter
Deprecated.
Writes documentation comments from a string.
writeDocs(T, Runnable) - Method in interface software.amazon.smithy.codegen.core.writer.DocumentationWriter
Deprecated.
Writes documentation comments.
writeDocs(T, Runnable) - Method in interface software.amazon.smithy.codegen.core.writer.DocWriter
Deprecated.
Writes documentation comments.
writerDelegator() - Method in interface software.amazon.smithy.codegen.core.CodegenContext
Get the WriterDelegator used for generating code.
WriterDelegator<W extends SymbolWriter<W,? extends ImportContainer>> - Class in software.amazon.smithy.codegen.core
Creates and manages SymbolWriters for files and namespaces based on Symbols created for a Shape.
WriterDelegator(FileManifest, SymbolProvider, SymbolWriter.Factory<W>) - Constructor for class software.amazon.smithy.codegen.core.WriterDelegator
 
A B C D E F G H I J L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form