org.apache.reef.common

Interface Failure

All Superinterfaces:

Identifiable

All Known Subinterfaces:

FailedContext

All Known Implementing Classes:

AbstractFailure, FailedContextImpl, FailedJob, FailedRuntime, FailedTask

public interface Failure
extends Identifiable

Common interface for all error messages in REEF. Most of its functionality is generic and implemented in the AbstractFailure class.

Method Summary

Methods

Modifier and Type	Method and Description
Throwable	asError() Return the original Java Exception, or generate a new one if it does not exists.
Optional<byte[]>	getData()
Optional<String>	getDescription()
String	getMessage()
Optional<Throwable>	getReason()

Methods inherited from interface org.apache.reef.io.naming.Identifiable

getId

Method Detail

getMessage

String getMessage()

Returns:

One-line error message. Should never be null.

getDescription

Optional<String> getDescription()

Returns:

Optional long error description.

getReason

Optional<Throwable> getReason()

Returns:

Java Exception that caused the error, if any.

getData

Optional<byte[]> getData()

Returns:

Optional serialized version of the error message.

asError

Throwable asError()

Return the original Java Exception, or generate a new one if it does not exists. ALWAYS returns an exception.

Returns:

A java exception. Never null.