Package software.amazon.smithy.docgen.integrations

Class BuiltinsIntegration

java.lang.Object

software.amazon.smithy.docgen.integrations.BuiltinsIntegration

All Implemented Interfaces:

SmithyIntegration<DocSettings,DocWriter,DocGenerationContext>, DocIntegration

public class BuiltinsIntegration
extends Object
implements DocIntegration

Applies the built-in DocFormats and base CodeSections.

This integration runs in high priority to ensure that other integrations can see and react to changes it makes. To have an integration reliably run before this, override SmithyIntegration.runBefore() with the output of SmithyIntegration.name() in the list. Similarly, to guarantee an integration is run after this, override SmithyIntegration.runAfter() with the same argument.

Constructor Summary

Constructors

Constructor	Description
BuiltinsIntegration()

Method Summary

Modifier and Type	Method	Description
List<DocFormat>	docFormats(DocSettings settings)	Adds DocFormats to the list of supported formats.
List<? extends CodeInterceptor<? extends CodeSection,DocWriter>>	interceptors(DocGenerationContext context)	Gets a list of CodeInterceptors to register with the AbstractCodeWriters created by the code generator.
byte	priority()	Gets the priority ordering relative to the topologically ordered integration graph determined by SmithyIntegration.runBefore() and SmithyIntegration.runAfter().

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.codegen.core.SmithyIntegration

configure, customize, decorateSymbolProvider, name, preprocessModel, runAfter, runBefore

Constructor Details

BuiltinsIntegration

public BuiltinsIntegration()

Method Details

priority

public byte priority()

Description copied from interface: SmithyIntegration

Gets the priority ordering relative to the topologically ordered integration graph determined by SmithyIntegration.runBefore() and SmithyIntegration.runAfter().

Higher numbers come before lower numbers.

When ordering, implementations must not allow cycles, and no two integrations may have the same name.

Specified by:

priority in interface SmithyIntegration<DocSettings,DocWriter,DocGenerationContext>

Returns:

Returns the priority order.

docFormats

public List<DocFormat> docFormats(DocSettings settings)

Description copied from interface: DocIntegration

Adds DocFormats to the list of supported formats.

When resolving the format implementation, the first format found with a matching name will be used. Use SmithyIntegration.priority() to adjust which integration is seen first.

Specified by:

docFormats in interface DocIntegration

Parameters:

settings - The documentation generation settings.

Returns:

A list of formats to add.

interceptors

public List<? extends CodeInterceptor<? extends CodeSection,DocWriter>> interceptors(DocGenerationContext context)

Description copied from interface: SmithyIntegration

Gets a list of CodeInterceptors to register with the AbstractCodeWriters created by the code generator.

This integration method should be called only after SmithyIntegration.preprocessModel(software.amazon.smithy.model.Model, S) and SmithyIntegration.decorateSymbolProvider(software.amazon.smithy.model.Model, S, software.amazon.smithy.codegen.core.SymbolProvider).

Specified by:

interceptors in interface SmithyIntegration<DocSettings,DocWriter,DocGenerationContext>

Parameters:

context - Code generation context that can be queried when creating interceptors.

Returns:

Returns the list of CodeInterceptors.