Package org.apache.sis.image
Interface ErrorHandler
public interface ErrorHandler
Action to perform when errors occurred while reading or writing some tiles in an image.
The most typical actions are throwing an exception or logging a warning.
- Since:
- 1.1
Defined in the sis-feature module
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic classInformation about errors that occurred while reading or writing tiles in an image. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ErrorHandlerExceptions are wrapped in aLogRecordand logged, usually atLevel.WARNING.static final ErrorHandlerExceptions are wrapped in anImagingOpExceptionand thrown. -
Method Summary
Modifier and TypeMethodDescriptionvoidhandle(ErrorHandler.Report details) Invoked after errors occurred in one or many tiles.
-
Field Details
-
THROW
Exceptions are wrapped in anImagingOpExceptionand thrown. In such case, no result is available. This is the default handler. -
LOG
Exceptions are wrapped in aLogRecordand logged, usually atLevel.WARNING. Only one log record is created for all tiles that failed for the same operation on the same image. A partial result may be available.Users are encouraged to use
THROWor to specify their ownErrorHandlerinstead of using this error action, because not everyone read logging records.
-
-
Method Details
-
handle
Invoked after errors occurred in one or many tiles. This method may be invoked an arbitrary time after the error occurred, and may aggregate errors that occurred in more than one tile.Multi-threading
If the image processing was splitted between many worker threads, this method may be invoked from any of those threads. However, the invocation should happen after all threads terminated, either successfully or with an error reported indetails.- Parameters:
details- information about the first error. If more than one error occurred, the other errors are reported as suppressed exceptions.
-