Class DittoException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.ditto.java.DittoException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DittoException.ActivationException, DittoException.AuthenticationException, DittoException.FatalException, DittoException.IoException, DittoException.PresenceException, DittoException.StoreException, DittoException.TransportException, DittoException.UnknownException, DittoException.UnsupportedException, DittoException.ValidationException

public abstract sealed class DittoException
extends Exception
permits DittoException.ActivationException, DittoException.AuthenticationException, DittoException.FatalException, DittoException.IoException, DittoException.PresenceException, DittoException.StoreException, DittoException.TransportException, DittoException.UnknownException, DittoException.UnsupportedException, DittoException.ValidationException

All errors that are thrown by the Ditto SDK are wrapped as a DittoException. This type wraps multiple different types of error that each have an associated reason. You can access more specific information about an error by switching over the error's reason value. A human-readable version of the error is available via the localizedMessage property of the error's reason.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DittoException.ActivationException	Represents an error that occurred during Ditto activation.
static interface	DittoException.ActivationExceptionReason	The possible underlying reasons an DittoException.ActivationException occurs.
static final class	DittoException.AuthenticationException	Represents an error that occurred during authentication with Ditto Cloud.
static interface	DittoException.AuthenticationExceptionReason	The possible underlying reasons an DittoException.AuthenticationException error occurs.
static final class	DittoException.FatalException	Represents a fatal error that the Ditto instance cannot recover from.
static final class	DittoException.IoException	Errors related to IO devices.
static interface	DittoException.IoExceptionReason	The possible underlying reasons an DittoException.IoException occurs.
static final class	DittoException.PresenceException	Errors transforming Ditto mesh presence data to or from JSON encoding.
static interface	DittoException.PresenceExceptionReason	The possible underlying reasons a DittoException.PresenceException occurs.
static final class	DittoException.StoreException	Represents an error that occurred during database or storage operations.
static interface	DittoException.StoreExceptionReason	The possible underlying reasons a DittoException.StoreException occurs.
static final class	DittoException.TransportException	Represents an error that occurred in the transport layer.
static interface	DittoException.TransportExceptionReason	The possible underlying reasons a DittoException.TransportException error occurs.
static final class	DittoException.UnknownException	Some not-yet-categorized error occurred.
static final class	DittoException.UnsupportedException	Operation is not supported.
static final class	DittoException.ValidationException	Represents a validation error for data or configuration.
static interface	DittoException.ValidationExceptionReason	The possible underlying reasons a DittoException.ValidationException occurs.

Field Summary

Fields

Modifier and Type	Field	Description
protected com.ditto.internal.error.InternalDittoErrorReason	internalReason

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DittoException(com.ditto.internal.error.InternalDittoErrorReason internalReason)

Method Summary

Modifier and Type	Method	Description
String	getLocalizedMessage()	A String representation of the error suitable for display.
String	getMessage()	A formatted description of the error.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, 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

Field Details

internalReason

protected com.ditto.internal.error.InternalDittoErrorReason internalReason

Constructor Details

DittoException

protected DittoException(com.ditto.internal.error.InternalDittoErrorReason internalReason)

Method Details

getMessage

public String getMessage()

A formatted description of the error. Not all errors have a message. Use the null-safe getLocalizedMessage() if you don't want to have to handle null values.

Overrides:

getMessage in class Throwable

getLocalizedMessage

public String getLocalizedMessage()

A String representation of the error suitable for display.

Overrides:

getLocalizedMessage in class Throwable