Package org.apache.beam.sdk.values

Class EncodableThrowable

java.lang.Object

org.apache.beam.sdk.values.EncodableThrowable

All Implemented Interfaces:

Serializable

public final class EncodableThrowable
extends Object
implements Serializable

A wrapper around a Throwable for use with coders.

Though Throwable is serializable, it doesn't override Object.equals(Object), which can lead to false positives in mutation detection for coders. This class provides a coder- safe way to pass exceptions around without running into problems like log spam.

This class is not suitable for general-purpose equality comparison among Throwables and should only be used to pass a Throwable from one PTransform to another.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static EncodableThrowable	forThrowable(Throwable throwable)	Wraps throwable and returns the result.
int	hashCode()
Throwable	throwable()	Returns the underlying Throwable.

Methods inherited from class java.lang.Object

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

Method Details

forThrowable

public static EncodableThrowable forThrowable(Throwable throwable)

Wraps throwable and returns the result.

throwable

public Throwable throwable()

Returns the underlying Throwable.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
 Object obj)

Overrides:

equals in class Object