Package software.amazon.smithy.docgen.interceptors

Class ReferencesInterceptor

java.lang.Object

software.amazon.smithy.docgen.interceptors.ReferencesInterceptor

All Implemented Interfaces:

CodeInterceptor<ShapeDetailsSection,DocWriter>, CodeInterceptor.Appender<ShapeDetailsSection,DocWriter>

public final class ReferencesInterceptor
extends Object
implements CodeInterceptor.Appender<ShapeDetailsSection,DocWriter>

Adds a "see also" to structures / operations that reference resources using the references trait.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.smithy.utils.CodeInterceptor

CodeInterceptor.Appender<S extends CodeSection,W extends AbstractCodeWriter<W>>, CodeInterceptor.Prepender<S extends CodeSection,W extends AbstractCodeWriter<W>>

Constructor Summary

Constructors

Constructor	Description
ReferencesInterceptor()

Method Summary

Modifier and Type	Method	Description
void	append(DocWriter writer, ShapeDetailsSection section)	Writes text after previous content in the section.
boolean	isIntercepted(ShapeDetailsSection section)	Checks if the given section is filtered by this interceptor or not.
Class<ShapeDetailsSection>	sectionType()	Get the strongly typed CodeSection this interceptor is used to intercept.

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.utils.CodeInterceptor.Appender

write

Constructor Details

ReferencesInterceptor

public ReferencesInterceptor()

Method Details

sectionType

public Class<ShapeDetailsSection> sectionType()

Description copied from interface: CodeInterceptor

Get the strongly typed CodeSection this interceptor is used to intercept.

Specified by:

sectionType in interface CodeInterceptor<ShapeDetailsSection,DocWriter>

Returns:

The code section to intercept.

isIntercepted

public boolean isIntercepted(ShapeDetailsSection section)

Description copied from interface: CodeInterceptor

Checks if the given section is filtered by this interceptor or not.

In some cases CodeInterceptor.sectionType() might allow filtering a wider array of types than what is actually filtered by an interceptor. The most common example of this is intercepting any type of CodeSection and only filtering based on the result of CodeSection.sectionName().

This method will return true by default, meaning that any type of CodeSection that is an instance of the class returned from CodeInterceptor.sectionType() will be intercepted.

Specified by:

isIntercepted in interface CodeInterceptor<ShapeDetailsSection,DocWriter>

Parameters:

section - Section to test if this interceptor is relevant.

Returns:

Returns true if the section is intercepted or not.

append

public void append(DocWriter writer,
 ShapeDetailsSection section)

Description copied from interface: CodeInterceptor.Appender

Writes text after previous content in the section.

Specified by:

append in interface CodeInterceptor.Appender<ShapeDetailsSection,DocWriter>

Parameters:

writer - The code writer to write to.

section - The section being intercepted.