FailureReport

java.lang.Object
- de.uka.ipd.sdq.beagle.core.failurehandling.FailureReport<RECOVER_TYPE>

Type Parameters:

RECOVER_TYPE - The return type of the recover functions.
```
public class FailureReport<RECOVER_TYPE>
extends Object
```
Information about a failure that occurred while running Beagle. Besides a message and information about the causing (or indicating) exception, a failure report may continue information on how to recover from a failure. The failure reported through this report is considered non-recoverable until a recover function has be set through recoverable(), retryWith(java.util.function.Supplier<RECOVER_TYPE>) or continueWith(java.util.function.Supplier<RECOVER_TYPE>).

Constructor Summary

Constructors
Constructor and Description

FailureReport()

Constructors
Constructor and Description
`FailureReport()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FailureReport<RECOVER_TYPE>`	`cause(Exception cause)` Supplies the exception that caused or indicated the failure.
`FailureReport<RECOVER_TYPE>`	`continueWith(Runnable continueAt)` Reports that the failure is recoverable by continuing by running `continueAt` .
`FailureReport<RECOVER_TYPE>`	`continueWith(Supplier<RECOVER_TYPE> continueAt)` Reports that the failure is recoverable by continuing by running `continueAt` .
`FailureReport<RECOVER_TYPE>`	`details(String message, Object... values)` Supplies a message giving details about the failure.
`Supplier<RECOVER_TYPE>`	`getContinueRoutine()` Gets the function that lets Beagle continue the analysis by skipping the failed action.
`String`	`getDetails()` Gets the report’s failure details.
`Exception`	`getFailureCause()` Gets the exception that caused or indicated the reported failure.
`String`	`getFailureMessage()` Gets the report’s failure description.
`Supplier<RECOVER_TYPE>`	`getRetryRoutine()` Gets the function that lets Beagle retry the failed failed action.
`FailureReport<RECOVER_TYPE>`	`message(String message, Object... values)` Supplies a message describing the failure.
`FailureReport<RECOVER_TYPE>`	`recoverable()` Reports that the failure is recoverable by continuing the normal control flow after the failure handling.
`FailureReport<RECOVER_TYPE>`	`retryWith(Runnable retryAt)` Reports that the failure is recoverable by retrying the failed action by running `retryAt`.
`FailureReport<RECOVER_TYPE>`	`retryWith(Supplier<RECOVER_TYPE> retryAt)` Reports that the failure is recoverable by retrying the failed action by running `retryAt`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FailureReport
```
public FailureReport()
```
- Method Detail
  - message
```
public FailureReport<RECOVER_TYPE> message(String message,
                                           Object... values)
```
    Supplies a message describing the failure. The message will be evaluated through String.format(String, Object...).
    
    Parameters:
    
    message - A message describing the failure. Must not be null.
    
    values - Format values, will be passed to String.format(String, Object...).
    
    Returns:
    
    this.
  - details
```
public FailureReport<RECOVER_TYPE> details(String message,
                                           Object... values)
```
    Supplies a message giving details about the failure. The message will be evaluated through String.format(String, Object...) and be perepended to potentally already existing details.
    
    Parameters:
    
    message - Details about the reported failure.
    
    values - Format values, will be passed to String.format(String, Object...).
    
    Returns:
    
    this.
  - cause
```
public FailureReport<RECOVER_TYPE> cause(Exception cause)
```
    Supplies the exception that caused or indicated the failure. If no message has been set on this report yet, the report’s message will be set to cause.getMessage(). The exception’s stacktrace will be appnended to the report’s details. A new report’s cause is null.
    
    Parameters:
    
    cause - The exception that caused or indicated the failure. Must not be null.
    
    Returns:
    
    this.
  - recoverable
```
public FailureReport<RECOVER_TYPE> recoverable()
```
    Reports that the failure is recoverable by continuing the normal control flow after the failure handling. The failure reporter will receive null as the result of handling this report.
    
    Returns:
    
    this.
  - continueWith
```
public FailureReport<RECOVER_TYPE> continueWith(Supplier<RECOVER_TYPE> continueAt)
```
    Reports that the failure is recoverable by continuing by running continueAt .
    
    Parameters:
    
    continueAt - A function defining how to continue while skipping the failed action. Supplies the value the failure reporter should use instead of the one that was expected to be generated skipped action.
    
    Returns:
    
    this.
  - continueWith
```
public FailureReport<RECOVER_TYPE> continueWith(Runnable continueAt)
```
    Reports that the failure is recoverable by continuing by running continueAt . The failure reporter will receive null as the result of handling this report.
    
    Parameters:
    
    continueAt - A runnable defining how to continue while skipping the failed action.
    
    Returns:
    
    this.
  - retryWith
```
public FailureReport<RECOVER_TYPE> retryWith(Supplier<RECOVER_TYPE> retryAt)
```
    Reports that the failure is recoverable by retrying the failed action by running retryAt.
    
    Parameters:
    
    retryAt - A function defining how to retry the failed action. Supplies the value the reporter should use instead of the one that was expected to be generated by the failed action.
    
    Returns:
    
    this.
  - retryWith
```
public FailureReport<RECOVER_TYPE> retryWith(Runnable retryAt)
```
    Reports that the failure is recoverable by retrying the failed action by running retryAt. The failure reporter will receive null as the result of handling this report.
    
    Parameters:
    
    retryAt - A runnable defining how to retry the failed action.
    
    Returns:
    
    this.
  - getFailureMessage
```
public String getFailureMessage()
```
    Gets the report’s failure description.
    
    Returns:
    
    A description of the failure. null indicates that there’s no information available.
    
    See Also:
    
    message(String, Object...)
  - getDetails
```
public String getDetails()
```
    Gets the report’s failure details.
    
    Returns:
    
    Details about the failure. null indicates that there’s no information available.
    
    See Also:
    
    details(String, Object...)
  - getFailureCause
```
public Exception getFailureCause()
```
    Gets the exception that caused or indicated the reported failure.
    
    Returns:
    
    The causing exception. null indicates that the reported failure was not caused by an exception.
    
    See Also:
    
    cause(Exception)
  - getContinueRoutine
```
public Supplier<RECOVER_TYPE> getContinueRoutine()
```
    Gets the function that lets Beagle continue the analysis by skipping the failed action.
    
    Returns:
    
    The function detailing how to continue. null indicates that Beagle cannot continue without the failed action.
    
    See Also:
    
    recoverable(), continueWith(Runnable)
  - getRetryRoutine
```
public Supplier<RECOVER_TYPE> getRetryRoutine()
```
    Gets the function that lets Beagle retry the failed failed action.
    
    Returns:
    
    The function detailing how to retry the failed action. null indicates that the failed action cannot be retried.
    
    See Also:
    
    retryWith(Runnable)

Class FailureReport<RECOVER_TYPE>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FailureReport

Method Detail

message

details

cause

recoverable

continueWith

continueWith

retryWith

retryWith

getFailureMessage

getDetails

getFailureCause

getContinueRoutine

getRetryRoutine