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.diagnostics;
018
019/**
020 * A {@code FailureAnalyzer} is used to analyze a failure and provide diagnostic
021 * information that can be displayed to the user.
022 *
023 * @author Andy Wilkinson
024 * @since 1.4.0
025 */
026@FunctionalInterface
027public interface FailureAnalyzer {
028
029        /**
030         * Returns an analysis of the given {@code failure}, or {@code null} if no analysis
031         * was possible.
032         * @param failure the failure
033         * @return the analysis or {@code null}
034         */
035        FailureAnalysis analyze(Throwable failure);
036
037}