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