Package software.amazon.smithy.docgen.interceptors

Class HostLabelInterceptor

java.lang.Object

software.amazon.smithy.docgen.interceptors.HostLabelInterceptor

All Implemented Interfaces:

CodeInterceptor<ProtocolSection,DocWriter>

public final class HostLabelInterceptor
extends Object

Documents usage for members targeted with the hostLabel trait if the protocol supports it..

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

Method Summary

Modifier and Type	Method	Description
protected Class<HostLabelTrait>	getTraitClass()
protected ShapeId	getTraitId()
boolean	isIntercepted(ProtocolSection section)	Checks if the given section is filtered by this interceptor or not.
Class<ProtocolSection>	sectionType()	Get the strongly typed CodeSection this interceptor is used to intercept.
void	write(DocWriter writer, String previousText, ProtocolSection 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

HostLabelInterceptor

public HostLabelInterceptor()

Method Details

getTraitClass

protected Class<HostLabelTrait> getTraitClass()

Returns:

returns the class of the protocol trait.

getTraitId

protected ShapeId getTraitId()

Returns:

returns the shape id of the protocol trait.

isIntercepted

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

Parameters:

section - Section to test if this interceptor is relevant.

Returns:

Returns true if the section is intercepted or not.

sectionType

public Class<ProtocolSection> sectionType()

Description copied from interface: CodeInterceptor

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

Specified by:

sectionType in interface CodeInterceptor<ProtocolSection,DocWriter>

Returns:

The code section to intercept.

write

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

Description copied from interface: CodeInterceptor

Intercepts an AbstractCodeWriter section.

Specified by:

write in interface CodeInterceptor<ProtocolSection,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.