Module jakarta.xml.bind
Package jakarta.xml.bind.util

Class ValidationEventCollector

java.lang.Object
jakarta.xml.bind.util.ValidationEventCollector
All Implemented Interfaces:
ValidationEventHandler
public class ValidationEventCollector extends Object implements ValidationEventHandler
ValidationEventHandler implementation that collects all events.

To use this class, create a new instance and pass it to the setEventHandler method of the Unmarshaller, Marshaller class. After the call to validate or unmarshal completes, call the getEvents method to retrieve all the reported errors and warnings.

Author:
  • Kohsuke Kawaguchi, Sun Microsystems, Inc.
  • Ryan Shoemaker, Sun Microsystems, Inc.
  • Joe Fialli, Sun Microsystems, Inc.
See Also:

  • Constructor Details

    • ValidationEventCollector

      public ValidationEventCollector()

  • Method Details

    • getEvents

      public ValidationEvent[] getEvents()
      Return an array of ValidationEvent objects containing a copy of each of the collected errors and warnings.
      Returns:
      a copy of all the collected errors and warnings or an empty array if there weren't any

    • reset

      public void reset()
      Clear all collected errors and warnings.

    • hasEvents

      public boolean hasEvents()
      Returns true if this event collector contains at least one ValidationEvent.
      Returns:
      true if this event collector contains at least one ValidationEvent, false otherwise

    • handleEvent

      public boolean handleEvent(ValidationEvent event)
      Description copied from interface: ValidationEventHandler
      Receive notification of a validation warning or error.

      The ValidationEvent will have a ValidationEventLocator embedded in it that indicates where the error or warning occurred.

      If an unchecked runtime exception is thrown from this method, the Jakarta XML Binding provider will treat it as if the method returned false and interrupt the current unmarshal, validate, or marshal operation.

      Specified by:
      handleEvent in interface ValidationEventHandler
      Parameters:
      event - the encapsulated validation event information. It is a provider error if this parameter is null.
      Returns:
      true if the Jakarta XML Binding 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.