Package org.apache.juneau.marshall.serializer

Class SerializeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.juneau.commons.BasicRuntimeException

org.apache.juneau.marshall.BasicRuntimeException

org.apache.juneau.marshall.serializer.SerializeException

All Implemented Interfaces:

Serializable

public class SerializeException
extends BasicRuntimeException

General exception thrown whenever an error occurs during serialization.

See Also:

• Serializers and Parsers

Constructor Summary

Constructors

Constructor	Description
SerializeException(String message, Object... args)	Constructor.
SerializeException(Throwable causedBy)	Constructor.
SerializeException(SerializerSession session, Exception causedBy)	Constructor.
SerializeException(SerializerSession session, String message, Object... args)	Constructor.

Method Summary

Modifier and Type	Method	Description
static SerializeException	create(Throwable e)	Creator method.
SerializeException	getRootCause()	Returns the highest-level SerializeException in the stack trace.
SerializeException	initCause(Throwable cause)	Sets the inner cause for this exception.
SerializeException	setMessage(String message, Object... args)	Sets the detail message on this exception.

Methods inherited from class org.apache.juneau.commons.BasicRuntimeException

getMessage

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Details

SerializeException

public SerializeException(SerializerSession session,
 Exception causedBy)

Constructor.

Parameters:

session - The serializer session to extract information from. Can be null (the message is not augmented with location info).

causedBy - The inner exception. Must not be null.

SerializeException

public SerializeException(SerializerSession session,
 String message,
 Object... args)

Constructor.

Parameters:

session - The serializer session to extract information from. Can be null (the message is not augmented with location info).

message - The exception message containing String.format-style (%s) arguments.

args - Optional String.format-style arguments.

SerializeException

public SerializeException(String message,
 Object... args)

Constructor.

Parameters:

message - The exception message containing String.format-style (%s) arguments.

args - Optional String.format-style arguments.

SerializeException

public SerializeException(Throwable causedBy)

Constructor.

Parameters:

causedBy - The inner exception. Must not be null.

Method Details

create

public static SerializeException create(Throwable e)

Creator method.

If the throwable is already a SerializeException, we simply return that exception as-is. If the throwable is an InvocationTargetException, we unwrap the thrown exception. Otherwise we create a new SerializeException.

Parameters:

e - The exception being wrapped or unwrapped. Must not be null.

Returns:

The specified throwable wrapped or unwrapped as a SerializeException (may be the same instance if it already was one).

getRootCause

public SerializeException getRootCause()

Returns the highest-level SerializeException in the stack trace. Useful for JUnit testing of error conditions.

Returns:

The root serialize exception, or this exception if there isn't one.

initCause

public SerializeException initCause(Throwable cause)

Sets the inner cause for this exception.

Overrides:

initCause in class Throwable

Parameters:

cause - The inner cause.

Returns:

This object.

setMessage

public SerializeException setMessage(String message,
 Object... args)

Description copied from class: BasicRuntimeException

Sets the detail message on this exception.

Overrides:

setMessage in class BasicRuntimeException

Parameters:

message - The message.

args - The message args.

Returns:

This object.