1 /*
   2  * Copyright (c) 2009, 2020, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.xml.stream;
  27 
  28 /**
  29  * This interface is used to report non-fatal errors.
  30  * Only warnings should be echoed through this interface.
  31  * @version 1.0
  32  * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
  33  * @since 1.6
  34  */
  35 public interface XMLReporter {
  36 
  37     /**
  38      * Report the desired message in an application specific format.
  39      * Only warnings and non-fatal errors should be reported through
  40      * this interface.
  41      * Fatal errors should be thrown as XMLStreamException.
  42      *
  43      * @param message the error message
  44      * @param errorType an implementation defined error type
  45      * @param relatedInformation information related to the error, if available
  46      * @param location the location of the error, if available
  47      * @throws XMLStreamException if an error occurs
  48      */
  49     public void report(String message, String errorType, Object relatedInformation, Location location)
  50             throws XMLStreamException;
  51 }