software.amazon.smithy.aws.cloudformation.traits.CfnResourceTrait Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smithy-aws-cloudformation-traits Show documentation
This module provides Smithy traits and validators for CloudFormation.
There is a newer version: 1.53.0
Show newest version
/*
 * Copyright 2020 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.smithy.aws.cloudformation.traits;

import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import software.amazon.smithy.model.node.Node;
import software.amazon.smithy.model.node.NodeMapper;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.traits.AbstractTrait;
import software.amazon.smithy.model.traits.AbstractTraitBuilder;
import software.amazon.smithy.model.traits.Trait;
import software.amazon.smithy.utils.ListUtils;
import software.amazon.smithy.utils.SmithyBuilder;
import software.amazon.smithy.utils.ToSmithyBuilder;

/**
 * Indicates that a Smithy resource is a CloudFormation resource.
 */
public final class CfnResourceTrait extends AbstractTrait
        implements ToSmithyBuilder {
    public static final ShapeId ID = ShapeId.from("aws.cloudformation#cfnResource");

    private final String name;
    private final List additionalSchemas;

    private CfnResourceTrait(Builder builder) {
        super(ID, builder.getSourceLocation());
        name = builder.name;
        additionalSchemas = ListUtils.copyOf(builder.additionalSchemas);
    }

    /**
     * Get the AWS CloudFormation resource name.
     *
     * @return Returns the name.
     */
    public Optional getName() {
        return Optional.ofNullable(name);
    }

    /**
     * Get the Smithy structure shape Ids for additional schema properties.
     *
     * @return Returns the additional schema shape Ids.
     */
    public List getAdditionalSchemas() {
        return additionalSchemas;
    }

    public static Builder builder() {
        return new Builder();
    }

    @Override
    protected Node createNode() {
        NodeMapper mapper = new NodeMapper();
        mapper.disableToNodeForClass(CfnResourceTrait.class);
        mapper.setOmitEmptyValues(true);
        return mapper.serialize(this).expectObjectNode();
    }

    @Override
    public SmithyBuilder toBuilder() {
        return builder().sourceLocation(getSourceLocation()).name(name).additionalSchemas(additionalSchemas);
    }

    public static final class Provider extends AbstractTrait.Provider {
        public Provider() {
            super(ID);
        }

        @Override
        public Trait createTrait(ShapeId target, Node value) {
            CfnResourceTrait result = new NodeMapper().deserialize(value, CfnResourceTrait.class);
            result.setNodeCache(value);
            return result;
        }
    }

    public static final class Builder extends AbstractTraitBuilder {
        private String name;
        private final List additionalSchemas = new ArrayList<>();

        private Builder() {}

        @Override
        public CfnResourceTrait build() {
            return new CfnResourceTrait(this);
        }

        public Builder name(String name) {
            this.name = name;
            return this;
        }

        public Builder addAdditionalSchema(ShapeId additionalSchema) {
            this.additionalSchemas.add(additionalSchema);
            return this;
        }

        public Builder additionalSchemas(List additionalSchemas) {
            this.additionalSchemas.clear();
            this.additionalSchemas.addAll(additionalSchemas);
            return this;
        }
    }
}