software.amazon.smithy.build.transforms.ExcludeShapesByTrait Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smithy-build Show documentation

This module is a library used to validate Smithy models, create filtered projections of a model, and generate build artifacts.

There is a newer version: 1.54.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.build.transforms;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import software.amazon.smithy.build.TransformContext;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.loader.Prelude;
import software.amazon.smithy.model.shapes.ShapeId;

/**
 * Removes shapes from the model if they are marked with a specific trait.
 */
public final class ExcludeShapesByTrait extends ConfigurableProjectionTransformer {

    public static final class Config {
        private Set traits = Collections.emptySet();

        /**
         * Gets the shape IDs of the traits to filter shapes by.
         *
         * Relative shape IDs are assumed to be in the smithy.api namespace.
         *
         * @return Returns the trait shape IDs.
         */
        public Set getTraits() {
            return traits;
        }

        /**
         * Sets the shape IDs of the traits to filter shapes by.
         *
         * @param traits The shape IDs of the traits that if present causes a shape to be removed.
         */
        public void setTraits(Set traits) {
            this.traits = traits;
        }
    }

    @Override
    public String getName() {
        return "excludeShapesByTrait";
    }

    @Override
    public Class getConfigType() {
        return Config.class;
    }

    protected Model transformWithConfig(TransformContext context, Config config) {
        // Resolve relative IDs by defaulting to smithy.api# if the given trait ID is relative.
        Set ids = new HashSet<>(config.getTraits().size());
        for (String id : config.getTraits()) {
            ids.add(ShapeId.fromOptionalNamespace(Prelude.NAMESPACE, id));
        }

        return context.getTransformer().removeShapesIf(context.getModel(), shape -> {
            return ids.stream().anyMatch(shape::hasTrait);
        });
    }
}