javax.xml.stream.XMLReporter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stax-api

StAX is a standard XML processing API that allows you to stream XML data from and to your application.

There is a newer version: 1.0-2

package javax.xml.stream;

/**
 * This interface is used to report non-fatal errors.
 * Only warnings should be echoed through this interface.
 * @version 1.0
 * @author Copyright (c) 2003 by BEA Systems. All Rights Reserved.
 */
public interface XMLReporter {

  /**
   * Report the desired message in an application specific format.
   * Only warnings and non-fatal errors should be reported through 
   * this interface. 
   * Fatal errors should be thrown as XMLStreamException.
   *
   * @param message the error message
   * @param errorType an implementation defined error type
   * @param relatedInformation information related to the error, if available
   * @param location the location of the error, if available
   * @throws XMLStreamException
   */
  public void report(String message, String errorType, Object relatedInformation, Location location) 
    throws XMLStreamException;
}