software.amazon.smithy.model.validation.validators.UnstableTraitValidator Maven / Gradle / Ivy

Go to download
/*
 * 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.model.validation.validators;

import static java.lang.String.format;

import java.util.ArrayList;
import java.util.List;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.traits.UnstableTrait;
import software.amazon.smithy.model.validation.AbstractValidator;
import software.amazon.smithy.model.validation.ValidationEvent;

/**
 * Emits a validation event if a model contains shapes that are bound to unstable traits.
 */
public final class UnstableTraitValidator extends AbstractValidator {
    @Override
    public List validate(Model model) {
        List events = new ArrayList<>(0);

        for (Shape trait : model.getShapesWithTrait(UnstableTrait.class)) {
            for (Shape appliedTo : model.getShapesWithTrait(trait)) {
                events.add(warning(
                        appliedTo,
                        appliedTo.findTrait(trait.getId()).get(), // point to the applied trait which for sure exists.
                        format("This shape applies a trait that is unstable: %s", trait.toShapeId()),
                        trait.toShapeId().toString())
                );
            }
        }

        return events;
    }
}