software.amazon.smithy.traitcodegen.integrations.javadoc.DeprecatedInterceptor Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0
*/
package software.amazon.smithy.traitcodegen.integrations.javadoc;
import software.amazon.smithy.model.traits.DeprecatedTrait;
import software.amazon.smithy.traitcodegen.sections.JavaDocSection;
import software.amazon.smithy.traitcodegen.writer.TraitCodegenWriter;
import software.amazon.smithy.utils.CodeInterceptor;
/**
* Adds the {@code @deprecated} javadoc tag to generated Javadoc documentation for a class
* if the smithy shape the class corresponds to has the {@link DeprecatedTrait} trait applied.
*
* If the {@code DeprecatedTrait} contains a {@code since} field, then "As of " note will be added
* to the generated tag.
*
Note: This interceptor should be run after {@link SinceInterceptor} and {@link ExternalDocumentationInterceptor}
* to ensure proper tag ordering.
*/
final class DeprecatedInterceptor implements CodeInterceptor.Appender {
@Override
public void append(TraitCodegenWriter writer, JavaDocSection section) {
DeprecatedTrait trait = section.shape().expectTrait(DeprecatedTrait.class);
// Only add the deprecated java doc tag if message or since message exist.
if (trait.getSince().isPresent() || trait.getMessage().isPresent()) {
writer.putContext("since", trait.getSince());
writer.write("@deprecated ${?since}As of ${since:L}. ${/since}$L", trait.getMessage());
}
}
@Override
public Class sectionType() {
return JavaDocSection.class;
}
@Override
public boolean isIntercepted(JavaDocSection section) {
return section.shape().hasTrait(DeprecatedTrait.class);
}
}