software.amazon.awssdk.codegen.poet.model.DeprecationUtils Maven / Gradle / Ivy

Go to download
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

package software.amazon.awssdk.codegen.poet.model;

import static java.util.stream.Collectors.toList;
import static software.amazon.awssdk.codegen.internal.Constant.LF;

import com.squareup.javapoet.AnnotationSpec;
import com.squareup.javapoet.MethodSpec;
import java.util.List;
import software.amazon.awssdk.codegen.model.intermediate.MemberModel;
import software.amazon.awssdk.codegen.model.intermediate.OperationModel;
import software.amazon.awssdk.utils.StringUtils;

public final class DeprecationUtils {

    private static final AnnotationSpec DEPRECATED = AnnotationSpec.builder(Deprecated.class).build();

    private DeprecationUtils() {
    }

    /**
     * If a given member is modeled as deprecated, add the {@link Deprecated} annotation to the method and, if the method
     * already has existing Javadoc, append a section with the {@code @deprecated} tag.
     */
    public static MethodSpec checkDeprecated(MemberModel member, MethodSpec method) {
        if (!member.isDeprecated() || method.annotations.contains(DEPRECATED)) {
            return method;
        }
        MethodSpec.Builder builder = method.toBuilder().addAnnotation(DEPRECATED);
        if (!method.javadoc.isEmpty()) {
            builder.addJavadoc(LF + "@deprecated");
            if (StringUtils.isNotBlank(member.getDeprecatedMessage())) {
                builder.addJavadoc(" $L", member.getDeprecatedMessage());
            }
        }
        return builder.build();
    }

    /**
     * If a given operation is modeled as deprecated, add the {@link Deprecated} annotation to the method and, if the method
     * already has existing Javadoc, append a section with the {@code @deprecated} tag.
     */
    public static MethodSpec checkDeprecated(OperationModel operation, MethodSpec method) {
        if (!operation.isDeprecated() || method.annotations.contains(DEPRECATED)) {
            return method;
        }
        MethodSpec.Builder builder = method.toBuilder().addAnnotation(DEPRECATED);
        if (!method.javadoc.isEmpty()) {
            builder.addJavadoc(LF + "@deprecated");
            if (StringUtils.isNotBlank(operation.getDeprecatedMessage())) {
                builder.addJavadoc(" $L", operation.getDeprecatedMessage());
            }
        }
        return builder.build();
    }

    public static List checkDeprecated(MemberModel member, List methods) {
        return methods.stream().map(methodSpec -> checkDeprecated(member, methodSpec)).collect(toList());
    }
}