software.amazon.smithy.traitcodegen.generators.GetterGenerator Maven / Gradle / Ivy

Go to download
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

package software.amazon.smithy.traitcodegen.generators;

import java.util.Optional;
import software.amazon.smithy.codegen.core.Symbol;
import software.amazon.smithy.codegen.core.SymbolProvider;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.node.Node;
import software.amazon.smithy.model.shapes.DocumentShape;
import software.amazon.smithy.model.shapes.EnumShape;
import software.amazon.smithy.model.shapes.IntEnumShape;
import software.amazon.smithy.model.shapes.ListShape;
import software.amazon.smithy.model.shapes.MapShape;
import software.amazon.smithy.model.shapes.MemberShape;
import software.amazon.smithy.model.shapes.NumberShape;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.shapes.StringShape;
import software.amazon.smithy.model.shapes.StructureShape;
import software.amazon.smithy.model.shapes.TimestampShape;
import software.amazon.smithy.traitcodegen.TraitCodegenUtils;
import software.amazon.smithy.traitcodegen.sections.GetterSection;
import software.amazon.smithy.traitcodegen.writer.TraitCodegenWriter;

/**
 * Generates getter methods for each shape member or the value type held by the trait.
 *
 * Optional member getters will return the member type wrapped in an {@code Optional}.
 */
final class GetterGenerator implements Runnable {
    private final TraitCodegenWriter writer;
    private final SymbolProvider symbolProvider;
    private final Model model;
    private final Shape shape;

    GetterGenerator(TraitCodegenWriter writer, SymbolProvider symbolProvider, Model model, Shape shape) {
        this.writer = writer;
        this.symbolProvider = symbolProvider;
        this.model = model;
        this.shape = shape;
    }

    @Override
    public void run() {
        shape.accept(new GetterVisitor());
    }

    public final class GetterVisitor extends TraitVisitor {

        @Override
        public Void documentShape(DocumentShape shape) {
            writer.openBlock("public $T getValue() {", "}", Node.class,
                    () -> writer.writeWithNoFormatting("return toNode();"));
            writer.newLine();
            return null;
        }

        @Override
        public Void listShape(ListShape shape) {
            if (TraitCodegenUtils.isJavaStringList(shape, symbolProvider)) {
                return null;
            }
            generateValuesGetter(shape);
            return null;
        }

        @Override
        public Void mapShape(MapShape shape) {
            generateValuesGetter(shape);
            return null;
        }

        @Override
        public Void stringShape(StringShape shape) {
            if (TraitCodegenUtils.isJavaString(symbolProvider.toSymbol(shape))) {
                return null;
            }
            generateValueGetter(shape);
            return null;
        }

        @Override
        public Void enumShape(EnumShape shape) {
            Symbol shapeSymbol = symbolProvider.toSymbol(shape);
            generateEnumValueGetterDocstring(shapeSymbol);
            writer.openBlock("public $B getEnumValue() {", "}",
                    shapeSymbol,
                    () -> writer.write("return $B.from(getValue());", shapeSymbol));
            writer.newLine();
            return null;
        }

        @Override
        public Void intEnumShape(IntEnumShape shape) {
            writer.pushState(new GetterSection(shape));
            writer.openBlock("public $T getValue() {", "}",
                    Integer.class, () -> writer.write("return value;"));
            writer.popState();
            writer.newLine();

            Symbol shapeSymbol = symbolProvider.toSymbol(shape);
            generateEnumValueGetterDocstring(shapeSymbol);
            writer.openBlock("public $B getEnumValue() {", "}",
                    shapeSymbol,
                    () -> writer.write("return $B.from(value);", shapeSymbol));
            writer.newLine();
            return null;
        }

        @Override
        public Void structureShape(StructureShape shape) {
            for (MemberShape member : shape.members()) {
                // If the member is required or the type does not require an optional wrapper (such as a list or map)
                // then do not wrap return in an Optional
                writer.pushState(new GetterSection(member));
                if (TraitCodegenUtils.isNullableMember(member)) {
                    writer.openBlock("public $T<$T> get$U() {", "}",
                            Optional.class, symbolProvider.toSymbol(member), symbolProvider.toMemberName(member),
                            () -> writer.write("return $T.ofNullable($L);",
                                    Optional.class, symbolProvider.toMemberName(member)));
                    writer.popState();
                    writer.newLine();

                    // If the member targets a collection shape and is optional then generate an unwrapped
                    // getter as a convenience method as well.
                    Shape target = model.expectShape(member.getTarget());
                    if (target.isListShape() || target.isMapShape()) {
                        writer.openBlock("public $T get$UOrEmpty() {", "}",
                                symbolProvider.toSymbol(member),
                                symbolProvider.toMemberName(member),
                                () -> writer.write("return $L;", symbolProvider.toMemberName(member)));
                    }
                } else {
                    writer.openBlock("public $T get$U() {", "}",
                            symbolProvider.toSymbol(member),
                            symbolProvider.toMemberName(member),
                            () -> writer.write("return $L;", symbolProvider.toMemberName(member)));
                    writer.popState();
                }
                writer.newLine();
            }
            return null;
        }

        @Override
        public Void timestampShape(TimestampShape shape) {
            generateValueGetter(shape);
            return null;
        }

        @Override
        protected Void numberShape(NumberShape shape) {
            generateValueGetter(shape);
            return null;
        }

        private void generateEnumValueGetterDocstring(Symbol symbol) {
            writer.writeDocString(writer.format("Gets the {@code $1T} value as a {@code $1B} enum.\n\n"
                    + "@return Returns the {@code $1B} enum.",
                    symbol));
        }

        private void generateValuesGetter(Shape shape) {
            writer.pushState(new GetterSection(shape));
            writer.openBlock("public $B getValues() {", "}",
                    symbolProvider.toSymbol(shape), () -> writer.write("return values;"));
            writer.popState();
            writer.newLine();
        }

        private void generateValueGetter(Shape shape) {
            writer.pushState(new GetterSection(shape));
            writer.openBlock("public $B getValue() {", "}",
                    symbolProvider.toSymbol(shape), () -> writer.write("return value;"));
            writer.popState();
            writer.newLine();
        }
    }
}