001/*
002 * Copyright 2012-2018 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.validation;
018
019import org.springframework.util.Assert;
020
021/**
022 * Error thrown when validation fails during a bind operation.
023 *
024 * @author Phillip Webb
025 * @author Madhura Bhave
026 * @since 2.0.0
027 * @see ValidationErrors
028 * @see ValidationBindHandler
029 */
030public class BindValidationException extends RuntimeException {
031
032        private final ValidationErrors validationErrors;
033
034        BindValidationException(ValidationErrors validationErrors) {
035                super(getMessage(validationErrors));
036                Assert.notNull(validationErrors, "ValidationErrors must not be null");
037                this.validationErrors = validationErrors;
038        }
039
040        /**
041         * Return the validation errors that caused the exception.
042         * @return the validationErrors the validation errors
043         */
044        public ValidationErrors getValidationErrors() {
045                return this.validationErrors;
046        }
047
048        private static String getMessage(ValidationErrors errors) {
049                StringBuilder message = new StringBuilder("Binding validation errors");
050                if (errors != null) {
051                        message.append(" on " + errors.getName());
052                        errors.getAllErrors().forEach(
053                                        (error) -> message.append(String.format("%n   - %s", error)));
054                }
055                return message.toString();
056        }
057
058}