/*
 * Copyright 2012-2020 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.config;

import org.springframework.boot.context.properties.bind.BindContext;
import org.springframework.boot.context.properties.bind.BindException;
import org.springframework.boot.context.properties.bind.BindHandler;
import org.springframework.boot.context.properties.bind.Bindable;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.boot.context.properties.source.ConfigurationProperty;
import org.springframework.boot.context.properties.source.ConfigurationPropertyName;

Exception thrown if legacy processing must be used.
Author:
Phillip Webb, Madhura Bhave/**
 * Exception thrown if legacy processing must be used.
 *
 * @author Phillip Webb
 * @author Madhura Bhave
 */
final class UseLegacyConfigProcessingException extends ConfigDataException {

	
The property name used to trigger legacy processing.
/**
	 * The property name used to trigger legacy processing.
	 */
	static final ConfigurationPropertyName PROPERTY_NAME = ConfigurationPropertyName
			.of("spring.config.use-legacy-processing");

	private static final Bindable<Boolean> BOOLEAN = Bindable.of(Boolean.class);

	private static final UseLegacyProcessingBindHandler BIND_HANDLER = new UseLegacyProcessingBindHandler();

	private final ConfigurationProperty configurationProperty;

	UseLegacyConfigProcessingException(ConfigurationProperty configurationProperty) {
		super("Legacy processing requested from " + configurationProperty, null);
		this.configurationProperty = configurationProperty;
	}

	
Return the source configuration property that requested the use of legacy
processing.
Returns:
the configurationProperty the configuration property/**
	 * Return the source configuration property that requested the use of legacy
	 * processing.
	 * @return the configurationProperty the configuration property
	 */
	ConfigurationProperty getConfigurationProperty() {
		return this.configurationProperty;
	}

	
Throw a new UseLegacyConfigProcessingException instance if PROPERTY_NAME binds to true. 
Params:
binder – the binder to use/**
	 * Throw a new {@link UseLegacyConfigProcessingException} instance if
	 * {@link #PROPERTY_NAME} binds to {@code true}.
	 * @param binder the binder to use
	 */
	static void throwIfRequested(Binder binder) {
		try {
			binder.bind(PROPERTY_NAME, BOOLEAN, BIND_HANDLER);
		}
		catch (BindException ex) {
			if (ex.getCause() instanceof UseLegacyConfigProcessingException) {
				throw (UseLegacyConfigProcessingException) ex.getCause();
			}
			throw ex;
		}
	}

	
BindHandler used to check for legacy processing properties. /**
	 * {@link BindHandler} used to check for legacy processing properties.
	 */
	private static class UseLegacyProcessingBindHandler implements BindHandler {

		@Override
		public Object onSuccess(ConfigurationPropertyName name, Bindable<?> target, BindContext context,
				Object result) {
			if (Boolean.TRUE.equals(result)) {
				throw new UseLegacyConfigProcessingException(context.getConfigurationProperty());
			}
			return result;
		}

	}

}