software.amazon.smithy.model.validation.ValidatorService 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 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.function.Function;
import java.util.function.Supplier;
import software.amazon.smithy.model.node.ObjectNode;

/**
 * Represents a service provider for configurable Validators that appear
 * in Smithy models.
 */
public interface ValidatorService {
    /**
     * Gets the name of the validator.
     *
     * This name is used to find a matching validator configured in the
     * Smithy model and match it to an implementation.
     *
     * @return Returns the name of the validator it creates.
     */
    String getName();

    /**
     * Creates a validator using configuration.
     *
     * @param configuration Validator configuration.
     * @return Returns the created validator.
     */
    Validator createValidator(ObjectNode configuration);

    /**
     * Determines the name of a validator based on a class name.
     *
     * This method returns the simple name of a class and strips off
     * "Validator" from the end of the name if present.
     *
     * @param clazz Class to determine the validator name of.
     * @return Returns the validator name based on heuristics.
     */
    static String determineValidatorName(Class clazz) {
        String name = clazz.getSimpleName();
        return name.endsWith("Validator") ? name.substring(0, name.length() - "Validator".length()) : name;
    }

    /**
     * Provides a simple abstraction for creating validator service subclasses.
     */
    abstract class Provider implements ValidatorService {
        private String name;
        private Function provider;

        public Provider(String name, Function provider) {
            this.name = name;
            this.provider = provider;
        }

        public  Provider(Class klass, Function provider) {
            this(determineValidatorName(klass), provider);
        }

        public  Provider(Class klass, Supplier supplier) {
            this(determineValidatorName(klass), c -> supplier.get());
        }

        @Override
        public final String getName() {
            return name;
        }

        @Override
        public final Validator createValidator(ObjectNode configuration) {
            return provider.apply(configuration);
        }
    }
}