Package com.google.gwt.core.shared

Class SerializableThrowable

java.lang.Object
java.lang.Throwable
com.google.gwt.core.shared.SerializableThrowable
All Implemented Interfaces:
Serializable
public final class SerializableThrowable extends Throwable
A serializable copy of a Throwable, including its causes and stack trace. It overrides #toString to mimic original Throwable.toString() so that Throwable.printStackTrace() will work as if it is coming from the original exception.

This class is especially useful for logging and testing as the emulated Throwable class does not serialize recursively and does not serialize the stack trace. This class, as an alternative, can be used to transfer the Throwable without losing any of these data, even if the underlying Throwable is not serializable.

Please note that, to get more useful stack traces from client side, this class needs to be used in conjunction with StackTraceDeobfuscator.

NOTE: Does not serialize suppressed exceptions to remain compatible with Java 6 and below.

See Also:

  • Constructor Details

    • SerializableThrowable

      public SerializableThrowable(String designatedType, String message)
      Constructs a new SerializableThrowable with the specified detail message.

  • Method Details

    • fromThrowable

      public static SerializableThrowable fromThrowable(Throwable throwable)
      Create a new SerializableThrowable from a provided throwable and its causes recursively.
      Returns:
      a new SerializableThrowable or the passed object itself if it is null or already a SerializableThrowable.

    • fillInStackTrace

      public Throwable fillInStackTrace()
      Overrides:
      fillInStackTrace in class Throwable

    • setDesignatedType

      public void setDesignatedType(String typeName, boolean isExactType)
      Sets the designated Throwable's type name.
      Parameters:
      typeName - the class name of the underlying designated throwable.
      isExactType - false if provided type name is not the exact type.
      See Also:

    • getDesignatedType

      public String getDesignatedType()
      Returns the designated throwable's type name.
      See Also:

    • isExactDesignatedTypeKnown

      public boolean isExactDesignatedTypeKnown()
      Return true if provided type name is the exact type of the throwable that is designated by this instance. This can return false if the class metadata is not available in the runtime. In that case getDesignatedType() will return the type resolved by best-effort and may not be the exact type; instead it can be one of the ancestors of the real type that this instance designates.

    • initCause

      public Throwable initCause(Throwable cause)
      Initializes the cause of this throwable.

      This method will convert the cause to SerializableThrowable if it is not already.

      Overrides:
      initCause in class Throwable

    • getOriginalThrowable

      public Throwable getOriginalThrowable()
      Returns the original throwable that this serializable throwable is derived from. Note that the original throwable is kept in a transient field; that is; it will not be transferred to server side. In that case this method will return null.

    • toString

      public String toString()
      Overrides:
      toString in class Throwable