software.amazon.smithy.model.validation.Validator Maven / Gradle / Ivy
Show all versions of smithy-model Show documentation
/*
* 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;
import java.util.List;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.loader.ModelAssembler;
/**
* Validates a {@link Model} and returns a list of {@link ValidationEvent}.
*
* A {@code Validator} is used to enforce constraints on a model. This
* interface is used to implement both built-in validation that runs on all
* Smithy loaded models and custom validators that can be registered when
* loading a model. Registering a {@code Validator} class as a service
* provider for the {@code Validator} interface will cause the validator
* to be applied each time a Model is built using a {@link ModelAssembler}.
*
*
The {@link ValidatorService} class is used to provide a service provider
* for validators that can be configured in the Smithy model via the
* {@code validators[]} metadata.
*
* @see ValidationEvent
*/
@FunctionalInterface
public interface Validator {
/** Event ID used for structural errors encountered when loading a model. */
String MODEL_ERROR = "Model";
/** Event ID used when something in the model is deprecated. */
String MODEL_DEPRECATION = "ModelDeprecation";
/**
* Validates a model and returns a list of validation events.
*
* @param model Model to validate.
* @return List of validation events.
*/
List validate(Model model);
}