Package software.amazon.smithy.docgen.interceptors

Class DeprecatedInterceptor

java.lang.Object

software.amazon.smithy.docgen.interceptors.DeprecatedInterceptor

All Implemented Interfaces:

CodeInterceptor<ShapeSubheadingSection,DocWriter>

public final class DeprecatedInterceptor
extends Object
implements CodeInterceptor<ShapeSubheadingSection,DocWriter>

Adds deprecation warnings to shape docs.

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

Method Summary

Modifier and Type	Method	Description
boolean	isIntercepted(ShapeSubheadingSection section)	Checks if the given section is filtered by this interceptor or not.
Class<ShapeSubheadingSection>	sectionType()	Get the strongly typed CodeSection this interceptor is used to intercept.
void	write(DocWriter writer, String previousText, ShapeSubheadingSection section)	Intercepts an AbstractCodeWriter section.

Methods inherited from class java.lang.Object

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

Constructor Details

DeprecatedInterceptor

public DeprecatedInterceptor()

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.

write

public void write(DocWriter writer,
 String previousText,
 ShapeSubheadingSection section)

Description copied from interface: CodeInterceptor

Intercepts an AbstractCodeWriter section.

Specified by:

write in interface CodeInterceptor<ShapeSubheadingSection,DocWriter>

Parameters:

writer - Writer used to write content. If no write calls are made, any intercepted text is lost.

previousText - The previous text that was written. This text needs to be written again in order for it to be kept in the section.

section - The strongly typed section value.