software.amazon.smithy.model.shapes.NamedMembersShapeBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smithy-model Show documentation
This module provides the core implementation of loading, validating, traversing, mutating, and serializing a Smithy model.
The newest version!
/*
 * Copyright 2021 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.model.shapes;

import java.util.Collection;
import java.util.Map;
import java.util.Optional;
import java.util.function.Consumer;
import software.amazon.smithy.utils.BuilderRef;

/**
 * Builder used to create a List or Set shape.
 * @param  Concrete builder type.
 * @param  Shape type being created.
 */
abstract class NamedMembersShapeBuilder, S extends Shape>
        extends AbstractShapeBuilder {

    protected final BuilderRef> members = BuilderRef.forOrderedMap();

    @Override
    public Optional getMember(String memberName) {
        return Optional.ofNullable(members.get().get(memberName));
    }

    @Override
    public final B id(ShapeId shapeId) {
        // If there are already any members set, update their ids to point to the new parent id.
        for (MemberShape member : members.peek().values()) {
            addMember(member.toBuilder().id(shapeId.withMember(member.getMemberName())).build());
        }
        return super.id(shapeId);
    }

    /**
     * Replaces the members of the builder.
     *
     * @param members Members to add to the builder.
     * @return Returns the builder.
     */
    @SuppressWarnings("unchecked")
    public B members(Collection members) {
        clearMembers();
        for (MemberShape member : members) {
            addMember(member);
        }
        return (B) this;
    }

    @Override
    @SuppressWarnings("unchecked")
    public B clearMembers() {
        members.clear();
        return (B) this;
    }

    @Override
    @SuppressWarnings("unchecked")
    public B addMember(MemberShape member) {
        members.get().put(member.getMemberName(), member);
        return (B) this;
    }

    /**
     * Adds a member to the builder.
     *
     * @param memberName Member name to add.
     * @param target Target of the member.
     * @return Returns the builder.
     */
    public B addMember(String memberName, ShapeId target) {
        return addMember(memberName, target, null);
    }

    /**
     * Adds a member to the builder.
     *
     * @param memberName Member name to add.
     * @param target Target of the member.
     * @param memberUpdater Consumer that can update the created member shape.
     * @return Returns the builder.
     */
    public B addMember(String memberName, ShapeId target, Consumer memberUpdater) {
        if (getId() == null) {
            throw new IllegalStateException("An id must be set before setting a member with a target");
        }

        MemberShape.Builder builder = MemberShape.builder().target(target).id(getId().withMember(memberName));

        if (memberUpdater != null) {
            memberUpdater.accept(builder);
        }

        return addMember(builder.build());
    }

    /**
     * Removes a member by name.
     *
     * Note that removing a member that was added by a mixin results in
     * an inconsistent model. It's best to use ModelTransform to ensure
     * that the model remains consistent when removing members.
     *
     * @param member Member name to remove.
     * @return Returns the builder.
     */
    @SuppressWarnings("unchecked")
    public B removeMember(String member) {
        if (members.hasValue()) {
            members.get().remove(member);
        }
        return (B) this;
    }

    @Override
    @SuppressWarnings("unchecked")
    public B addMixin(Shape shape) {
        if (getId() == null) {
            throw new IllegalStateException("An id must be set before adding a mixin");
        }
        super.addMixin(shape);
        NamedMemberUtils.cleanMixins(shape, members.get());
        return (B) this;
    }

    @Override
    @SuppressWarnings("unchecked")
    public B removeMixin(ToShapeId shape) {
        super.removeMixin(shape);
        NamedMemberUtils.removeMixin(shape, members.get());
        return (B) this;
    }

    @Override
    @SuppressWarnings("unchecked")
    public B flattenMixins() {
        if (getMixins().isEmpty()) {
            return (B) this;
        }
        members(NamedMemberUtils.flattenMixins(members.get(), getMixins(), getId(), getSourceLocation()));
        return super.flattenMixins();
    }
}