org.springframework.boot.context.properties.bind.BindConstructorProvider Maven / Gradle / Ivy
/*
* Copyright 2012-2019 the original author or authors.
*
* Licensed 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
*
* https://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.springframework.boot.context.properties.bind;
import java.lang.reflect.Constructor;
/**
* Strategy interface used to determine a specific constructor to use when binding.
*
* @author Madhura Bhave
* @since 2.2.1
*/
@FunctionalInterface
public interface BindConstructorProvider {
/**
* Default {@link BindConstructorProvider} implementation that only returns a value
* when there's a single constructor and when the bindable has no existing value.
*/
BindConstructorProvider DEFAULT = new DefaultBindConstructorProvider();
/**
* Return the bind constructor to use for the given bindable, or {@code null} if
* constructor binding is not supported.
* @param bindable the bindable to check
* @param isNestedConstructorBinding if this binding is nested within a constructor
* binding
* @return the bind constructor or {@code null}
*/
Constructor getBindConstructor(Bindable bindable, boolean isNestedConstructorBinding);
}