Package software.amazon.smithy.docgen.interceptors

Class RetryableInterceptor

java.lang.Object

software.amazon.smithy.docgen.interceptors.RetryableInterceptor

All Implemented Interfaces:

CodeInterceptor<ShapeSubheadingSection,DocWriter>, CodeInterceptor.Prepender<ShapeSubheadingSection,DocWriter>

public final class RetryableInterceptor
extends Object
implements CodeInterceptor.Prepender<ShapeSubheadingSection,DocWriter>

This adds badges and notices to errors that are retryable.

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
RetryableInterceptor()

Method Summary

Modifier and Type	Method	Description
boolean	isIntercepted(ShapeSubheadingSection section)	Checks if the given section is filtered by this interceptor or not.
void	prepend(DocWriter writer, ShapeSubheadingSection section)	Writes text before previously written content in the section.
Class<ShapeSubheadingSection>	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.Prepender

write

Constructor Details

RetryableInterceptor

public RetryableInterceptor()

Method Details

sectionType

public Class<ShapeSubheadingSection> sectionType()

Description copied from interface: CodeInterceptor

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

Specified by:

sectionType in interface CodeInterceptor<ShapeSubheadingSection,DocWriter>

Returns:

The code section to intercept.

isIntercepted

public boolean isIntercepted(ShapeSubheadingSection 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<ShapeSubheadingSection,DocWriter>

Parameters:

section - Section to test if this interceptor is relevant.

Returns:

Returns true if the section is intercepted or not.

prepend

public void prepend(DocWriter writer,
 ShapeSubheadingSection section)

Description copied from interface: CodeInterceptor.Prepender

Writes text before previously written content in the section.

Specified by:

prepend in interface CodeInterceptor.Prepender<ShapeSubheadingSection,DocWriter>

Parameters:

writer - The code writer to write to.

section - The section being intercepted.