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;
018
019import org.springframework.context.ApplicationContextAware;
020import org.springframework.context.ConfigurableApplicationContext;
021import org.springframework.core.io.support.SpringFactoriesLoader;
022
023/**
024 * Callback interface used to support custom reporting of {@link SpringApplication}
025 * startup errors. {@link SpringBootExceptionReporter reporters} are loaded via the
026 * {@link SpringFactoriesLoader} and must declare a public constructor with a single
027 * {@link ConfigurableApplicationContext} parameter.
028 *
029 * @author Phillip Webb
030 * @since 2.0.0
031 * @see ApplicationContextAware
032 */
033@FunctionalInterface
034public interface SpringBootExceptionReporter {
035
036        /**
037         * Report a startup failure to the user.
038         * @param failure the source failure
039         * @return {@code true} if the failure was reported or {@code false} if default
040         * reporting should occur.
041         */
042        boolean reportException(Throwable failure);
043
044}