com.amazon.ion

Class IonException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.amazon.ion.IonException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

_Private_ScalarConversions.ConversionException, ContainedValueException, EmptySymbolException, InvalidSystemSymbolException, NullValueException, OversizedValueException, ReadOnlyValueException, SubstituteSymbolTableException, UnexpectedEofException, UnknownSymbolException, UnsupportedIonVersionException

public class IonException
extends java.lang.RuntimeException

Base class for exceptions thrown throughout this library. In most cases, external exceptions (a common example being IOException) are not propagated directly but are instead wrapped in one or more IonExceptions.

This library does not promise that such an "external cause" will be the direct cause of the thrown exception: there there may be a chain of multiple IonException before getting to the external cause. Here's an example of how to deal with this in a situation where the caller wants to propagate IOExceptions:

    try {
        // Call some API
    }
    catch (IonException e) {
        IOException io = e.causeOfType(IOException.class);
        if (io != null) throw io;
        throw e;
    }

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IonException()
IonException(java.lang.String message)
IonException(java.lang.String message, java.lang.Throwable cause)
IonException(java.lang.Throwable cause) Constructs a new exception with the given cause, copying the message from the cause into this instance.

Method Summary

Modifier and Type	Method and Description
<T extends java.lang.Throwable> T	causeOfType(java.lang.Class<T> type) Finds the first exception in the Throwable.getCause() chain that is an instance of the given type.

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

IonException

public IonException()

IonException

public IonException(java.lang.String message)

IonException

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

IonException

public IonException(java.lang.Throwable cause)

Constructs a new exception with the given cause, copying the message from the cause into this instance.

Parameters:

cause - the root cause of the exception; must not be null.

Method Detail

causeOfType

public <T extends java.lang.Throwable> T causeOfType(java.lang.Class<T> type)

Finds the first exception in the Throwable.getCause() chain that is an instance of the given type.

Returns:

null if there's no cause of the given type.