io.jmix.ui.exception

Class AbstractUiExceptionHandler

java.lang.Object

io.jmix.ui.exception.AbstractUiExceptionHandler

All Implemented Interfaces:

UiExceptionHandler

Direct Known Subclasses:

DeletePolicyExceptionHandler, FileStorageExceptionHandler

public abstract class AbstractUiExceptionHandler
extends java.lang.Object
implements UiExceptionHandler

Base class for exception handlers determining their ability to handle an exception by its class name and optional implementation of canHandle(String, String, Throwable) method.

If you need to handle a specific exception, create a descendant of this class, pass handled exception class names into constructor, implement #doHandle(String, String, Throwable, UiContext) method and annotate the class with @Component.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.exception.UiExceptionHandler

UiExceptionHandler.UiContext

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	classNames

Constructor Summary

Constructors

Constructor and Description
AbstractUiExceptionHandler(java.lang.String... classNames)

Method Summary

Modifier and Type	Method and Description
protected boolean	canHandle(java.lang.String className, java.lang.String message, java.lang.Throwable throwable) Should be implemented in subclasses if the exception class name is not enough to determine the ability to handle the exception.
protected abstract void	doHandle(java.lang.String className, java.lang.String message, java.lang.Throwable throwable, UiExceptionHandler.UiContext context) Perform exception handling.
boolean	handle(java.lang.Throwable exception, UiExceptionHandler.UiContext context) Handle an exception.

Methods inherited from class java.lang.Object

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

Field Detail

classNames

protected java.util.List<java.lang.String> classNames

Constructor Detail

AbstractUiExceptionHandler

public AbstractUiExceptionHandler(java.lang.String... classNames)

Method Detail

handle

public boolean handle(java.lang.Throwable exception,
                      UiExceptionHandler.UiContext context)

Description copied from interface: UiExceptionHandler

Handle an exception. Implementation class should either handle the exception and return true, or return false to delegate execution to the next handler in the chain of responsibility.

Specified by:

handle in interface UiExceptionHandler

Parameters:

exception - exception instance

context - UI context

Returns:

true if the exception has been successfully handled, false if not

canHandle

protected boolean canHandle(java.lang.String className,
                            java.lang.String message,
                            @Nullable
                            java.lang.Throwable throwable)

Should be implemented in subclasses if the exception class name is not enough to determine the ability to handle the exception.

Parameters:

className - exception class name

message - exception message

throwable - exception instance. Can be null if the exception occurred on the server side and this exception class isn't accessible by the client.

Returns:

true if the exception can be handled by this handler

doHandle

protected abstract void doHandle(java.lang.String className,
                                 java.lang.String message,
                                 @Nullable
                                 java.lang.Throwable throwable,
                                 UiExceptionHandler.UiContext context)

Perform exception handling.

Parameters:

className - actual exception class name

message - exception message

throwable - exception instance. Can be null if the exception occurred on the server side and this exception class isn't accessible by the client.

context - UI context