software.amazon.smithy.build.transforms.Apply 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.51.0

Show 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.build.transforms;

import java.util.List;
import java.util.Optional;
import java.util.function.BiFunction;
import software.amazon.smithy.build.TransformContext;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.utils.ListUtils;

/**
 * Applies transforms of other projections.
 */
public final class Apply extends BackwardCompatHelper {

    /**
     * {@code apply} configuration.
     */
    public static final class Config {
        private List projections;

        /**
         * Gets the ordered list of projections to apply by name.
         *
         * @return Returns the projection names to apply.
         */
        public List getProjections() {
            return projections;
        }

        /**
         * Sets the ordered list of projection names to apply.
         *
         * @param projections Projection names to apply.
         */
        public void setProjections(List projections) {
            this.projections = projections;
        }
    }

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

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

    @Override
    String getBackwardCompatibleNameMapping() {
        return "projections";
    }

    // Override this directly as apply will never transform the model,
    // so there's no reason to even deserialize the configuration for this
    @Override
    public Model transform(TransformContext context) {
        return context.getModel();
    }

    @Override
    protected Model transformWithConfig(TransformContext context, Config config) {
        throw new UnsupportedOperationException("transform(TransformContext) should be called directly.");
    }

    @Override
    protected Optional>> getAdditionalProjectionsFunction() {
        return Optional.of((context, config) -> ListUtils.copyOf(config.getProjections()));
    }

}