Package software.amazon.smithy.docgen

Class DocGenerationContext

java.lang.Object

software.amazon.smithy.docgen.DocGenerationContext

All Implemented Interfaces:

CodegenContext<DocSettings,DocWriter,DocIntegration>

public final class DocGenerationContext
extends Object
implements CodegenContext<DocSettings,DocWriter,DocIntegration>

Contextual information that is made available during most parts of documentation generation.

Constructor Summary

Constructors

Constructor	Description
DocGenerationContext(Model model, DocSettings docSettings, SymbolProvider symbolProvider, FileManifest fileManifest, List<DocIntegration> docIntegrations)	Constructor.

Method Summary

Modifier and Type	Method	Description
DocFormat	docFormat()
FileManifest	fileManifest()
List<DocIntegration>	integrations()
Model	model()
DocSettings	settings()
SymbolProvider	symbolProvider()
WriterDelegator<DocWriter>	writerDelegator()	Get the WriterDelegator used for generating code.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocGenerationContext

public DocGenerationContext(Model model,
 DocSettings docSettings,
 SymbolProvider symbolProvider,
 FileManifest fileManifest,
 List<DocIntegration> docIntegrations)

Constructor.

Parameters:

model - The source model to generate for.

docSettings - Settings to customize generation.

symbolProvider - The symbol provider to use to turn shapes into symbols.

fileManifest - The file manifest to write to.

docIntegrations - A list of integrations to apply during generation.

Method Details

model

public Model model()

Specified by:

model in interface CodegenContext<DocSettings,DocWriter,DocIntegration>

Returns:

Gets the model being code generated.

settings

public DocSettings settings()

Specified by:

settings in interface CodegenContext<DocSettings,DocWriter,DocIntegration>

Returns:

Gets code generation settings.

symbolProvider

public SymbolProvider symbolProvider()

Specified by:

symbolProvider in interface CodegenContext<DocSettings,DocWriter,DocIntegration>

Returns:

Gets the SymbolProvider used for code generation.

fileManifest

public FileManifest fileManifest()

Specified by:

fileManifest in interface CodegenContext<DocSettings,DocWriter,DocIntegration>

Returns:

Gets the FileManifest being written to for code generation.

writerDelegator

public WriterDelegator<DocWriter> writerDelegator()

Description copied from interface: CodegenContext

Get the WriterDelegator used for generating code.

Generates might need other delegators for specific purposes, and it's fine to add more methods for those specific purposes. If an implementation uses a specific subclass of a WriterDelegator, implementations can override this method to return a more specific WriterDelegator type.

Specified by:

writerDelegator in interface CodegenContext<DocSettings,DocWriter,DocIntegration>

Returns:

Returns the writer delegator used by the generator.

integrations

public List<DocIntegration> integrations()

Specified by:

integrations in interface CodegenContext<DocSettings,DocWriter,DocIntegration>

Returns:

Gets the SmithyIntegrations used for code generation.

docFormat

public DocFormat docFormat()

Returns:

Returns the selected format that documentation should be generated in.