Ion Java 1.11.10 · com.amazon.ion.IonException · APIdia, the JavaDoc alternative

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;
    }

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.lang.RuntimeException.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	IonException()
public	IonException(String message)
public	IonException(String message, Throwable cause)
public	IonException(Throwable the root cause of the exception; must not be null. 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
public <T extends Throwable> T	Returns: null if there's no cause of the given type. causeOfType(Class<T> type) Finds the first exception in the `getCause()` chain that is an instance of the given type.
pack-priv Throwable	Returns: null if there's no cause that's not an `IonException`. externalCause() Finds the first exception in the `getCause()` chain that's not an `IonException`.
private <T extends Throwable> void	rethrowCauseOfType(Class<T> type) Rethrows the first exception in the `getCause()` chain that is an instance of the given type.

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.lang.RuntimeException.serialVersionUID.

Constructor Detail

IonException	back to summary
public IonException()

IonException	back to summary
public IonException(String message)

IonException	back to summary
public IonException(String message, Throwable cause)

IonException	back to summary
public IonException(Throwable cause) Constructs a new exception with the given cause, copying the message from the cause into this instance. Parameters cause:Throwable the root cause of the exception; must not be null.

IonException

back to summary

public IonException(Throwable cause)

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

Parameters

cause:Throwable: the root cause of the exception; must not be null.

Method Detail

causeOfType back to summary

causeOfType	back to summary
public <T extends Throwable> T causeOfType(Class<T> type) Finds the first exception in the `getCause()` chain that is an instance of the given type. Returns:T null if there's no cause of the given type. Annotations @SuppressWarnings:unchecked

public <T extends Throwable> T causeOfType(Class<T> type)

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

Returns:T

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

Annotations

@SuppressWarnings:unchecked

externalCause back to summary

externalCause	back to summary
pack-priv Throwable externalCause() Finds the first exception in the `getCause()` chain that's not an `IonException`. Returns:Throwable null if there's no cause that's not an `IonException`.

pack-priv Throwable externalCause()

Finds the first exception in the getCause() chain that's not an IonException.

Returns:Throwable: null if there's no cause that's not an IonException.

rethrowCauseOfType back to summary

rethrowCauseOfType	back to summary
private <T extends Throwable> void rethrowCauseOfType(Class<T> type) throws Throwable Rethrows the first exception in the `getCause()` chain that is an instance of the given type. If no such cause is found, returns normally. FIXME Doesn't work under Java 5 Annotations @SuppressWarnings:unused

private <T extends Throwable> void rethrowCauseOfType(Class<T> type) throws Throwable

Rethrows the first exception in the getCause() chain that is an instance of the given type. If no such cause is found, returns normally. FIXME Doesn't work under Java 5