Module io.cloudevents.api

Package io.cloudevents.rw

Class CloudEventRWException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.cloudevents.rw.CloudEventRWException

All Implemented Interfaces:

Serializable

public class CloudEventRWException
extends RuntimeException

This class is the exception Protocol Binding and Event Format implementers can use to signal errors while serializing/deserializing CloudEvent.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CloudEventRWException.CloudEventRWExceptionKind	The kind of error that happened while serializing/deserializing

Method Summary

Modifier and Type	Method	Description
CloudEventRWException.CloudEventRWExceptionKind	getKind()
static CloudEventRWException	newDataConversion(Throwable cause, String from, String to)
static CloudEventRWException	newInvalidAttributeName(String attributeName)
static CloudEventRWException	newInvalidAttributeType(String attributeName, Class<?> clazz)
static CloudEventRWException	newInvalidAttributeType(String attributeName, Object value)
static CloudEventRWException	newInvalidAttributeValue(String attributeName, Object value, Throwable cause)
static CloudEventRWException	newInvalidDataType(String actual, String... allowed)
static CloudEventRWException	newInvalidExtensionName(String extensionName)
static CloudEventRWException	newInvalidSpecVersion(String specVersion)
static CloudEventRWException	newOther(String msg)	An exception for use where none of the other variants are appropriate.
static CloudEventRWException	newOther(Throwable cause)	This wraps a Throwable in a new generic instance of this exception.
static CloudEventRWException	newUnknownEncodingException()

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

Method Details

getKind

public CloudEventRWException.CloudEventRWExceptionKind getKind()

Returns:

the CloudEventRWException.CloudEventRWExceptionKind associated to this exception instance.

newInvalidSpecVersion

public static CloudEventRWException newInvalidSpecVersion(String specVersion)

Parameters:

specVersion - the invalid input spec version

Returns:

a new CloudEventRWException instance

newInvalidAttributeName

public static CloudEventRWException newInvalidAttributeName(String attributeName)

Parameters:

attributeName - the invalid attribute name

Returns:

a new CloudEventRWException instance

newInvalidExtensionName

public static CloudEventRWException newInvalidExtensionName(String extensionName)

Parameters:

extensionName - the invalid extension name

Returns:

a new CloudEventRWException instance

newInvalidAttributeType

public static CloudEventRWException newInvalidAttributeType(String attributeName,
 Class<?> clazz)

Parameters:

attributeName - the invalid attribute name

clazz - the type of the attribute

Returns:

a new CloudEventRWException instance

newInvalidAttributeType

public static CloudEventRWException newInvalidAttributeType(String attributeName,
 Object value)

newInvalidAttributeValue

public static CloudEventRWException newInvalidAttributeValue(String attributeName,
 Object value,
 @Nullable
 Throwable cause)

Parameters:

attributeName - the invalid attribute name

value - the value of the attribute

cause - an optional cause identifying the eventual validation error

Returns:

a new CloudEventRWException instance

newInvalidDataType

public static CloudEventRWException newInvalidDataType(String actual,
 String... allowed)

Parameters:

actual - the actual data type

allowed - the list of allowed data types

Returns:

a new CloudEventRWException instance

newDataConversion

public static CloudEventRWException newDataConversion(Throwable cause,
 String from,
 String to)

Parameters:

cause - the cause of the conversion failure

from - the input data type

to - the target data type

Returns:

a new CloudEventRWException instance

newUnknownEncodingException

public static CloudEventRWException newUnknownEncodingException()

Returns:

a new CloudEventRWException instance.

newOther

public static CloudEventRWException newOther(Throwable cause)

This wraps a Throwable in a new generic instance of this exception.

Parameters:

cause - the cause of the exception

Returns:

a new CloudEventRWException instance

newOther

public static CloudEventRWException newOther(String msg)

An exception for use where none of the other variants are appropriate.

Parameters:

msg - A description error message.

Returns:

a new CloudEventRWException