bval-jsr/src/main/java/org/apache/bval/jsr/metadata/MetadataSource.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License 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 org.apache.bval.jsr.metadata;

import java.util.function.BiConsumer;
import java.util.function.Consumer;

import javax.validation.ConstraintValidator;
import javax.validation.spi.ConfigurationState;

import org.apache.bval.jsr.ApacheValidatorFactory;

/**
 * Service interface for user metadata customizations.
 */
public interface MetadataSource {
    /**
     * Initialize the {@link MetadataSource}.
     * @param validatorFactory
     */
    default void initialize(ApacheValidatorFactory validatorFactory) {
    }

    /**
     * Add {@link ConstraintValidator} mappings and/or metadata builders.
     * 
     * @param configurationState
     *            may be read for environmental cues
     * @param addMappingProvider
     * @param addBuilder
     */
    void process(ConfigurationState configurationState, Consumer<ValidatorMappingProvider> addMappingProvider,
        BiConsumer<Class<?>, MetadataBuilder.ForBean<?>> addBuilder);
}