001/*
002 * Copyright 2012-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.context.properties.bind;
018
019import java.util.Collections;
020import java.util.Set;
021import java.util.stream.Collectors;
022
023import org.springframework.boot.context.properties.source.ConfigurationProperty;
024import org.springframework.boot.context.properties.source.ConfigurationPropertySource;
025
026/**
027 * {@link BindException} thrown when {@link ConfigurationPropertySource} elements were
028 * left unbound.
029 *
030 * @author Phillip Webb
031 * @author Madhura Bhave
032 * @since 2.0.0
033 */
034public class UnboundConfigurationPropertiesException extends RuntimeException {
035
036        private final Set<ConfigurationProperty> unboundProperties;
037
038        public UnboundConfigurationPropertiesException(
039                        Set<ConfigurationProperty> unboundProperties) {
040                super(buildMessage(unboundProperties));
041                this.unboundProperties = Collections.unmodifiableSet(unboundProperties);
042        }
043
044        public Set<ConfigurationProperty> getUnboundProperties() {
045                return this.unboundProperties;
046        }
047
048        private static String buildMessage(Set<ConfigurationProperty> unboundProperties) {
049                StringBuilder builder = new StringBuilder();
050                builder.append("The elements [");
051                String message = unboundProperties.stream().map((p) -> p.getName().toString())
052                                .collect(Collectors.joining(","));
053                builder.append(message).append("] were left unbound.");
054                return builder.toString();
055        }
056
057}