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

Go to download
/*
 * 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.HashSet;
import java.util.Set;
import java.util.TreeSet;
import software.amazon.smithy.aws.cloudformation.traits.CfnResourceIndex.Mutability;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.utils.SetUtils;
import software.amazon.smithy.utils.SmithyBuilder;
import software.amazon.smithy.utils.ToSmithyBuilder;

/**
 * Contains extracted resource property information.
 */
public final class CfnResourceProperty implements ToSmithyBuilder {
    private final Set shapeIds = new TreeSet<>();
    private final Set mutabilities;
    private final boolean hasExplicitMutability;

    private CfnResourceProperty(Builder builder) {
        shapeIds.addAll(builder.shapeIds);
        mutabilities = SetUtils.copyOf(builder.mutabilities);
        hasExplicitMutability = builder.hasExplicitMutability;
    }

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

    /*
     * Gets all shape IDs used for this property.
     *
     * The list of potential shape IDs is used only for validation,
     * as having only one shape ID is required.
     */
    Set getShapeIds() {
        return shapeIds;
    }

    /**
     * Gets the shape ID used to represent this property.
     *
     * @return Returns the shape ID.
     */
    public ShapeId getShapeId() {
        return shapeIds.iterator().next();
    }

    /**
     * Returns true if the property's mutability was configured explicitly
     * by the use of a trait instead of derived through its lifecycle
     * bindings within a resource.
     *
     *  Also returns true for identifiers, since their mutability is inherent
     *
     * @return Returns true if the mutability is explicitly defined by a trait or
     * if property is an identifier
     *
     * @see CfnMutabilityTrait
     */
    public boolean hasExplicitMutability() {
        return hasExplicitMutability;
    }

    /**
     * Gets all of the CloudFormation-specific property mutability options
     * associated with this resource property.
     *
     * @return Returns the mutabilities.
     */
    public Set getMutabilities() {
        return mutabilities;
    }

    @Override
    public Builder toBuilder() {
        return builder()
                .shapeIds(shapeIds)
                .mutabilities(mutabilities);
    }

    public static final class Builder implements SmithyBuilder {
        private final Set shapeIds = new TreeSet<>();
        private Set mutabilities = new HashSet<>();
        private boolean hasExplicitMutability = false;

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

        public Builder addShapeId(ShapeId shapeId) {
            this.shapeIds.add(shapeId);
            return this;
        }

        public Builder removeShapeId(ShapeId shapeId) {
            this.shapeIds.remove(shapeId);
            return this;
        }

        public Builder shapeIds(Set shapeIds) {
            this.shapeIds.clear();
            this.shapeIds.addAll(shapeIds);
            return this;
        }

        public Builder mutabilities(Set mutabilities) {
            this.mutabilities = mutabilities;
            return this;
        }

        public Builder hasExplicitMutability(boolean hasExplicitMutability) {
            this.hasExplicitMutability = hasExplicitMutability;
            return this;
        }
    }
}