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

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

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.neighbor.UnreferencedShapes;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.validation.AbstractValidator;
import software.amazon.smithy.model.validation.ValidationEvent;

/**
 * Adds a validation note event for each shape in the model that is not
 * connected to a service shape.
 *
 * This validator is deprecated and no longer applied by default.
 * Use the UnreferencedShapeValidator from smithy-linters instead.
 */
@Deprecated
public final class UnreferencedShapeValidator extends AbstractValidator {
    @Override
    public List validate(Model model) {
        // Do not emit validation warnings if no services are present in the model.
        if (model.getServiceShapes().isEmpty()) {
            return Collections.emptyList();
        }

        List events = new ArrayList<>();
        for (Shape shape : new UnreferencedShapes().compute(model)) {
            events.add(note(shape, String.format(
                    "The %s shape is not connected to from any service shape.", shape.getType())));
        }

        return events;
    }
}