Class FailureAnalysis

java.lang.Object

org.springframework.boot.diagnostics.FailureAnalysis

public class FailureAnalysis
extends Object

The result of analyzing a failure.

Since:

1.4.0

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor	Description
FailureAnalysis(@Nullable String description, @Nullable String action, Throwable cause)	Creates a new FailureAnalysis with the given description and action, if any, that the user should take to address the problem.

Method Summary

Modifier and Type	Method	Description
@Nullable String	getAction()	Returns the action, if any, to be taken to address the failure.
Throwable	getCause()	Returns the cause of the failure.
String	getDescription()	Returns a description of the failure.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FailureAnalysis

public FailureAnalysis(@Nullable String description,
 @Nullable String action,
 Throwable cause)

Creates a new FailureAnalysis with the given description and action, if any, that the user should take to address the problem. The failure had the given underlying cause.

Parameters:

description - the description

action - the action

cause - the cause

Method Details

getDescription

public String getDescription()

Returns a description of the failure.

Returns:

the description

getAction

public @Nullable String getAction()

Returns the action, if any, to be taken to address the failure.

Returns:

the action or null

getCause

public Throwable getCause()

Returns the cause of the failure.

Returns:

the cause