Module is.codion.swing.common.ui
Package is.codion.swing.common.ui.dialog

Interface ExceptionDialogBuilder

All Superinterfaces:
DialogBuilder<ExceptionDialogBuilder>
public interface ExceptionDialogBuilder extends DialogBuilder<ExceptionDialogBuilder>
An exception dialog builder.

  • Field Details

    • SYSTEM_PROPERTIES

      static final PropertyValue<Boolean> SYSTEM_PROPERTIES
      Specifies whether an ExceptionPanel should include system properties in the detail panel
      • Value type: Boolean
      • Default value: true

    • WRAPPER_EXCEPTIONS

      static final PropertyValue<List<Class<? extends Throwable>>> WRAPPER_EXCEPTIONS
      Specifies a list of exception types, which are considered wrapping exceptions, that is, exceptions that wrap a root cause.
      By default root cause exceptions are unwrapped before being displayed, in order to simplify the error message and stack trace.
      Replace with an empty list in order to disable unwrapping altogether.
      • Value type: String list
      • Default value: RemoteException, RuntimeException, InvocationTargetException, ExceptionInInitializerError, UndeclaredThrowableException

  • Method Details

    • message

      ExceptionDialogBuilder message(String message)
      Parameters:
      message - the message to display
      Returns:
      this builder instance

    • unwrap

      ExceptionDialogBuilder unwrap(boolean unwrap)
      Parameters:
      unwrap - false if exception unwrapping should not be performed
      Returns:
      this builder instance

    • unwrap

      ExceptionDialogBuilder unwrap(Collection<Class<? extends Throwable>> exceptions)
      Parameters:
      exceptions - the exceptions to unwrap before displaying
      Returns:
      this builder instance
      See Also:

    • systemProperties

      ExceptionDialogBuilder systemProperties(boolean systemProperties)
      Parameters:
      systemProperties - true if system properties should be displayed
      Returns:
      this builder instance
      See Also:

    • show

      void show(Throwable exception)
      Displays the exception dialog
      Parameters:
      exception - the exception to display

    • unwrap

      static Throwable unwrap(Throwable exception)
      Unwraps the given exception, using WRAPPER_EXCEPTIONS.
      Parameters:
      exception - the exception to unwrap
      Returns:
      the unwrapped exception

    • unwrap

      static Throwable unwrap(Throwable exception, Collection<Class<? extends Throwable>> wrapperExceptions)
      Unwraps the given exception.
      Parameters:
      exception - the exception to unwrap
      wrapperExceptions - the wrapper exceptions
      Returns:
      the unwrapped exception