software.amazon.smithy.model.validation.suppressions.Suppression Maven / Gradle / Ivy

Go to download

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

This module provides the core implementation of loading, validating, traversing, mutating, and serializing a Smithy model.

There is a newer version: 1.54.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.model.validation.suppressions;

import java.util.Optional;
import software.amazon.smithy.model.node.ExpectationNotMetException;
import software.amazon.smithy.model.node.Node;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.traits.SuppressTrait;
import software.amazon.smithy.model.validation.ValidationEvent;
import software.amazon.smithy.model.validation.Validator;

/**
 * Suppresses {@link ValidationEvent}s emitted from {@link Validator}s.
 */
@FunctionalInterface
public interface Suppression {

    /**
     * Determines if the suppression applies to the given event.
     *
     * @param event Event to test.
     * @return Returns true if the suppression applies.
     */
    boolean test(ValidationEvent event);

    /**
     * Gets the optional reason for the suppression.
     *
     * @return Returns the optional suppression reason.
     */
    default Optional getReason() {
        return Optional.empty();
    }

    /**
     * Creates a suppression using the {@link SuppressTrait} of
     * the given shape.
     *
     * @param shape Shape to get the {@link SuppressTrait} from.
     * @return Returns the created suppression.
     * @throws ExpectationNotMetException if the shape has no {@link SuppressTrait}.
     */
    static Suppression fromSuppressTrait(Shape shape) {
        return new TraitSuppression(shape.getId(), shape.expectTrait(SuppressTrait.class));
    }

    /**
     * Creates a suppression from a {@link Node} found in the
     * "suppressions" metadata of a Smithy model.
     *
     * @param node Node to parse.
     * @return Returns the loaded suppression.
     * @throws ExpectationNotMetException if the suppression node is malformed.
     */
    static Suppression fromMetadata(Node node) {
        return MetadataSuppression.fromNode(node);
    }
}