Package software.amazon.smithy.codegen.core.writer

Class SymbolWriter<T extends SymbolWriter<T,​U>,​U extends ImportContainer>

    • Constructor Detail

      • SymbolWriter

        public SymbolWriter​(DocWriter<T> documentationWriter,
                    U importContainer)
        Deprecated.
        Parameters:
        documentationWriter - Writes out documentation emitted by a Runnable.
        importContainer - Container used to persist and filter imports based on package names.

    • Method Detail

      • setRelativizeSymbols

        public T setRelativizeSymbols​(java.lang.String relativizeSymbols)
        Deprecated.
        Sets a string used to relativize Symbols formatted using the default T implementation used by CodegenWriter in the current state.

        In many programming languages, when referring to types in the same namespace as the current scope of a CodegenWriter, the symbols written in that scope don't need to be fully-qualified. They can just reference the unqualified type name. By setting a value for relativizeSymbols, if the result of Symbol.getNamespace() is equal to relativizeSymbols, then the unqualified name of the symbol is written to the CodegenWriter when the default implementation of T is written. Symbols that refer to types in other namespaces will write the fully qualified type.

        Note: This method may have no effect if a programming language does not use namespaces or concepts like namespaces or if T has been overridden with another implementation.

        Parameters:
        relativizeSymbols - The package name, namespace, etc to relativize symbols with.
        Returns:
        Returns the CodegenWriter.

      • getDocumentationWriter

        public final DocWriter<T> getDocumentationWriter()
        Deprecated.
        Gets the documentation writer.
        Returns:
        Returns the documentation writer.

      • getImportContainer

        public final U getImportContainer()
        Deprecated.
        Gets the import container associated with the writer.

        The AbstractCodeWriter.toString() method of the CodegenWriter should be overridden so that it includes the import container's contents in the output as appropriate.

        Returns:
        Returns the import container.

      • getDependencies

        public final java.util.List<SymbolDependency> getDependencies()
        Deprecated.
        Description copied from interface: SymbolDependencyContainer
        Gets the list of dependencies that this object introduces.

        A dependency is a dependency on another package that a Symbol or type requires. It is quite different from a reference since a reference only refers to a symbol; a reference provides no context as to whether or not a dependency is required or the dependency's coordinates.

        Specified by:
        getDependencies in interface SymbolDependencyContainer
        Returns:
        Returns the dependencies.

      • addDependency

        public final T addDependency​(SymbolDependencyContainer dependencies)
        Deprecated.
        Adds one or more dependencies to the generated code (represented as a SymbolDependency).

        Tracking dependencies on a CodegenWriter allows dependencies to be automatically aggregated and collected in order to generate configuration files for dependency management tools (e.g., npm, maven, etc).

        Parameters:
        dependencies - Dependency to add.
        Returns:
        Returns the writer.

      • addUseImports

        public T addUseImports​(SymbolContainer container)
        Deprecated.
        Imports one or more USE symbols using the name of the symbol (e.g., SymbolReference.ContextOption.USE references).

        USE references are only necessary when referring to a symbol, not declaring the symbol. For example, when referring to a List<Foo>, the USE references would be both the List type and Foo type.

        This method may be overridden as needed.

        Parameters:
        container - Symbols to add.
        Returns:
        Returns the writer.

      • addImport

        public final T addImport​(Symbol symbol,
                         java.lang.String alias,
                         SymbolReference.ContextOption... options)
        Deprecated.
        Imports a symbol (if necessary) using a specific alias and list of context options.

        This method automatically adds any dependencies of the symbol to the writer, calls ImportContainer.importSymbol(software.amazon.smithy.codegen.core.Symbol, java.lang.String), and automatically calls addImportReferences(software.amazon.smithy.codegen.core.Symbol, software.amazon.smithy.codegen.core.SymbolReference.ContextOption...) for the provided symbol.

        When called with no options, both USE and DECLARE symbols are imported from any references the Symbol might contain.

        Parameters:
        symbol - Symbol to optionally import.
        alias - The alias to refer to the symbol by.
        options - The list of context options (e.g., is it a USE or DECLARE symbol).
        Returns:
        Returns the writer.

      • writeDocs

        public final T writeDocs​(java.lang.Runnable runnable)
        Deprecated.
        Writes documentation comments.

        This method is responsible for setting up the writer to begin writing documentation comments. This includes writing any necessary opening tokens (e.g., "/*"), adding tokens to the beginning of lines (e.g., "*"), sanitizing documentation strings, and writing any tokens necessary to close documentation comments (e.g., "*\/").

        This method does not automatically escape the expression start character ("$" by default). Write calls made by the Runnable should either use AbstractCodeWriter.writeWithNoFormatting(java.lang.Object) or escape the expression start character manually.

        This method may be overridden as needed.

        Parameters:
        runnable - Runnable that handles actually writing docs with the writer.
        Returns:
        Returns the writer.

      • writeDocs

        public final T writeDocs​(java.lang.String docs)
        Deprecated.
        Writes documentation comments from a string.
        Parameters:
        docs - Documentation to write.
        Returns:
        Returns the writer.