org.apache.beam.sdk.coders

Class CannotProvideCoderException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.beam.sdk.coders.CannotProvideCoderException

All Implemented Interfaces:

java.io.Serializable

public class CannotProvideCoderException
extends java.lang.Exception

The exception thrown when a CoderRegistry or CoderProvider cannot provide a Coder that has been requested.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CannotProvideCoderException.ReasonCode Indicates the reason that Coder inference failed.

Constructor Summary

Constructors

Constructor and Description
CannotProvideCoderException(java.lang.String message)
CannotProvideCoderException(java.lang.String message, CannotProvideCoderException.ReasonCode reason)
CannotProvideCoderException(java.lang.String message, java.lang.Throwable cause)
CannotProvideCoderException(java.lang.String message, java.lang.Throwable cause, CannotProvideCoderException.ReasonCode reason)
CannotProvideCoderException(java.lang.Throwable cause)
CannotProvideCoderException(java.lang.Throwable cause, CannotProvideCoderException.ReasonCode reason)

Method Summary

Modifier and Type	Method and Description
CannotProvideCoderException.ReasonCode	getReason()
java.lang.Throwable	getRootCause() Returns the inner-most CannotProvideCoderException when they are deeply nested.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CannotProvideCoderException

public CannotProvideCoderException(java.lang.String message)

CannotProvideCoderException

public CannotProvideCoderException(java.lang.String message,
                                   CannotProvideCoderException.ReasonCode reason)

CannotProvideCoderException

public CannotProvideCoderException(java.lang.String message,
                                   java.lang.Throwable cause)

CannotProvideCoderException

public CannotProvideCoderException(java.lang.String message,
                                   java.lang.Throwable cause,
                                   CannotProvideCoderException.ReasonCode reason)

CannotProvideCoderException

public CannotProvideCoderException(java.lang.Throwable cause)

CannotProvideCoderException

public CannotProvideCoderException(java.lang.Throwable cause,
                                   CannotProvideCoderException.ReasonCode reason)

Method Detail

getReason

public CannotProvideCoderException.ReasonCode getReason()

Returns:

the reason that Coder inference failed.

getRootCause

public java.lang.Throwable getRootCause()

Returns the inner-most CannotProvideCoderException when they are deeply nested.

For example, if a coder for List<KV<Integer, Whatsit>> cannot be provided because there is no known coder for Whatsit, the root cause of the exception should be a CannotProvideCoderException with details pertinent to Whatsit, suppressing the intermediate layers.