software.amazon.smithy.build.transforms.IncludeMetadata 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 2019 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.Set;
import software.amazon.smithy.build.TransformContext;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.transform.ModelTransformer;

/**
 * {@code includeMetadata} keeps only metadata keys specifically
 * defined in the provided {@code keys} setting.
 */
public final class IncludeMetadata extends BackwardCompatHelper {

    /**
     * {@code includeMetadata} configuration settings.
     */
    public static final class Config {
        private Set keys = Collections.emptySet();

        /**
         * @return the list of keys to keep in metadata.
         */
        public Set getKeys() {
            return keys;
        }

        /**
         * Sets the list of keys to keep in metadata.
         *
         * @param keys Metadata keys to keep.
         */
        public void setKeys(Set keys) {
            this.keys = keys;
        }
    }

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

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

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

    @Override
    protected Model transformWithConfig(TransformContext context, Config config) {
        Model model = context.getModel();
        ModelTransformer transformer = context.getTransformer();
        Set keys = config.getKeys();
        return transformer.filterMetadata(model, (key, value) -> keys.contains(key));
    }
}