software.amazon.smithy.waiters.WaitableTrait Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smithy-waiters Show documentation
Defines Smithy waiters.
The 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.waiters;

import java.util.Map;
import software.amazon.smithy.model.node.Node;
import software.amazon.smithy.model.node.ObjectNode;
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.model.traits.TraitService;
import software.amazon.smithy.utils.BuilderRef;
import software.amazon.smithy.utils.SmithyBuilder;
import software.amazon.smithy.utils.ToSmithyBuilder;

/**
 * Indicates that an operation has various named "waiters" that can be used
 * to poll a resource until it enters a desired state.
 */
public final class WaitableTrait extends AbstractTrait implements ToSmithyBuilder {

    public static final ShapeId ID = ShapeId.from("smithy.waiters#waitable");

    private final Map waiters;

    private WaitableTrait(Builder builder) {
        super(ID, builder.getSourceLocation());
        this.waiters = builder.waiters.copy();
    }

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

    @Override
    public SmithyBuilder toBuilder() {
        return new Builder().sourceLocation(getSourceLocation()).replace(waiters);
    }

    /**
     * Gets the waiters defined on the trait.
     *
     * @return Returns the defined waiters.
     */
    public Map getWaiters() {
        return waiters;
    }

    @Override
    protected Node createNode() {
        ObjectNode.Builder builder = ObjectNode.objectNodeBuilder();
        builder.sourceLocation(getSourceLocation());
        for (Map.Entry entry : waiters.entrySet()) {
            builder.withMember(entry.getKey(), entry.getValue().toNode());
        }
        return builder.build();
    }

    public static final class Builder extends AbstractTraitBuilder {

        private final BuilderRef> waiters = BuilderRef.forOrderedMap();

        private Builder() {}

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

        public Builder put(String name, Waiter value) {
            waiters.get().put(name, value);
            return this;
        }

        public Builder clear() {
            this.waiters.clear();
            return this;
        }

        public Builder replace(Map waiters) {
            clear();
            this.waiters.get().putAll(waiters);
            return this;
        }
    }

    public static final class Provider implements TraitService {
        @Override
        public ShapeId getShapeId() {
            return ID;
        }

        @Override
        public Trait createTrait(ShapeId target, Node value) {
            ObjectNode node = value.expectObjectNode();
            Builder builder = builder().sourceLocation(value);
            for (Map.Entry entry : node.getStringMap().entrySet()) {
                builder.put(entry.getKey(), Waiter.fromNode(entry.getValue()));
            }
            WaitableTrait result = builder.build();
            result.setNodeCache(value);
            return result;
        }
    }
}