org.apache.reef.common

Class AbstractFailure

java.lang.Object

org.apache.reef.common.AbstractFailure

All Implemented Interfaces:

Failure, Identifiable

Direct Known Subclasses:

FailedContextImpl, FailedJob, FailedRuntime, FailedTask

public abstract class AbstractFailure
extends Object
implements Failure

Common data and functionality for all error messages in REEF.

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	getId() Returns an identifier of this object.
String	getMessage()
Optional<Throwable>	getReason()
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getId

public String getId()

Description copied from interface: Identifiable

Returns an identifier of this object.

Specified by:

getId in interface Identifiable

Returns:

Identifier of the entity that produced the error. Never null.

getMessage

public String getMessage()

Specified by:

getMessage in interface Failure

Returns:

One-line error message. Never null.

getDescription

public Optional<String> getDescription()

Specified by:

getDescription in interface Failure

Returns:

Optional long error description. For Java Exceptions, can contain stack trace.

getReason

public Optional<Throwable> getReason()

Specified by:

getReason in interface Failure

Returns:

Java Exception that caused the error, if any.

getData

public Optional<byte[]> getData()

Specified by:

getData in interface Failure

Returns:

Optional serialized version of the error message.

asError

public Throwable asError()

Return the original Java Exception, or generate a new one if it does not exists. ALWAYS returns an exception. FIXME: Replace RuntimeException with a better class.

Specified by:

asError in interface Failure

Returns:

A java exception. Never null.

toString

public String toString()

Overrides:

toString in class Object

Returns:

Human-readable string representation of an error message.