-
- All Known Implementing Classes:
- DefaultValidationEventHandler, ValidationEventCollector
public interface ValidationEventHandler
A basic event handler interface for validation errors.If an application needs to implement customized event handling, it must implement this interface and then register it with either the
Unmarshaller
, theValidator
, or theMarshaller
. The JAXB Provider will then report validation errors and warnings encountered during the unmarshal, marshal, and validate operations to these event handlers.If the handleEvent method throws an unchecked runtime exception, the JAXB Provider must treat that as if the method returned false, effectively terminating whatever operation was in progress at the time (unmarshal, validate, or marshal).
Modifying the Java content tree within your event handler is undefined by the specification and may result in unexpected behaviour.
Failing to return false from the handleEvent method after encountering a fatal error is undefined by the specification and may result in unexpected behavior.
Default Event Handler
See: Validator javadocs
- Since:
- JAXB1.0
- See Also:
Unmarshaller
,Validator
,Marshaller
,ValidationEvent
,ValidationEventCollector
-
-
Method Summary
Methods Modifier and Type Method and Description boolean
handleEvent(ValidationEvent event)
Receive notification of a validation warning or error.
-
-
-
Method Detail
-
handleEvent
boolean handleEvent(ValidationEvent event)
Receive notification of a validation warning or error. The ValidationEvent will have aValidationEventLocator
embedded in it that indicates where the error or warning occurred.If an unchecked runtime exception is thrown from this method, the JAXB provider will treat it as if the method returned false and interrupt the current unmarshal, validate, or marshal operation.
- Parameters:
event
- the encapsulated validation event information. It is a provider error if this parameter is null.- Returns:
- true if the JAXB Provider should attempt to continue the current unmarshal, validate, or marshal operation after handling this warning/error, false if the provider should terminate the current operation with the appropriate UnmarshalException, ValidationException, or MarshalException.
- Throws:
IllegalArgumentException
- if the event object is null.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/xml/bind/validationeventhandler.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.