src/org/mozilla/javascript/ErrorReporter.java

   1 /* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-\r
   2  *\r
   3  * The contents of this file are subject to the Netscape Public\r
   4  * License Version 1.1 (the "License"); you may not use this file\r
   5  * except in compliance with the License. You may obtain a copy of\r
   6  * the License at http://www.mozilla.org/NPL/\r
   7  *\r
   8  * Software distributed under the License is distributed on an "AS\r
   9  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express oqr\r
  10  * implied. See the License for the specific language governing\r
  11  * rights and limitations under the License.\r
  12  *\r
  13  * The Original Code is Rhino code, released\r
  14  * May 6, 1999.\r
  15  *\r
  16  * The Initial Developer of the Original Code is Netscape\r
  17  * Communications Corporation.  Portions created by Netscape are\r
  18  * Copyright (C) 1997-1999 Netscape Communications Corporation. All\r
  19  * Rights Reserved.\r
  20  *\r
  21  * Contributor(s): \r
  22  * Norris Boyd\r
  23  *\r
  24  * Alternatively, the contents of this file may be used under the\r
  25  * terms of the GNU Public License (the "GPL"), in which case the\r
  26  * provisions of the GPL are applicable instead of those above.\r
  27  * If you wish to allow use of your version of this file only\r
  28  * under the terms of the GPL and not to allow others to use your\r
  29  * version of this file under the NPL, indicate your decision by\r
  30  * deleting the provisions above and replace them with the notice\r
  31  * and other provisions required by the GPL.  If you do not delete\r
  32  * the provisions above, a recipient may use your version of this\r
  33  * file under either the NPL or the GPL.\r
  34  */\r
  35 \r
  36 // API class\r
  37 \r
  38 package org.mozilla.javascript;\r
  39 \r
  40 /**\r
  41  * This is interface defines a protocol for the reporting of\r
  42  * errors during JavaScript translation or execution.\r
  43  *\r
  44  * @author Norris Boyd\r
  45  */\r
  46 \r
  47 public interface ErrorReporter {\r
  48 \r
  49     /**\r
  50      * Report a warning.\r
  51      *\r
  52      * The implementing class may choose to ignore the warning\r
  53      * if it desires.\r
  54      *\r
  55      * @param message a String describing the warning\r
  56      * @param sourceName a String describing the JavaScript source\r
  57      * where the warning occured; typically a filename or URL\r
  58      * @param line the line number associated with the warning\r
  59      * @param lineSource the text of the line (may be null)\r
  60      * @param lineOffset the offset into lineSource where problem was detected\r
  61      */\r
  62     void warning(String message, String sourceName, int line,\r
  63                  String lineSource, int lineOffset);\r
  64 \r
  65     /**\r
  66      * Report an error.\r
  67      *\r
  68      * The implementing class is free to throw an exception if\r
  69      * it desires.\r
  70      *\r
  71      * If execution has not yet begun, the JavaScript engine is\r
  72      * free to find additional errors rather than terminating\r
  73      * the translation. It will not execute a script that had\r
  74      * errors, however.\r
  75      *\r
  76      * @param message a String describing the error\r
  77      * @param sourceName a String describing the JavaScript source\r
  78      * where the error occured; typically a filename or URL\r
  79      * @param line the line number associated with the error\r
  80      * @param lineSource the text of the line (may be null)\r
  81      * @param lineOffset the offset into lineSource where problem was detected\r
  82      */\r
  83     void error(String message, String sourceName, int line,\r
  84                String lineSource, int lineOffset);\r
  85 \r
  86     /**\r
  87      * Creates an EvaluatorException that may be thrown.\r
  88      *\r
  89      * runtimeErrors, unlike errors, will always terminate the\r
  90      * current script.\r
  91      *\r
  92      * @param message a String describing the error\r
  93      * @param sourceName a String describing the JavaScript source\r
  94      * where the error occured; typically a filename or URL\r
  95      * @param line the line number associated with the error\r
  96      * @param lineSource the text of the line (may be null)\r
  97      * @param lineOffset the offset into lineSource where problem was detected\r
  98      * @return an EvaluatorException that will be thrown.\r
  99      */\r
 100     EvaluatorException runtimeError(String message, String sourceName, \r
 101                                     int line, String lineSource, \r
 102                                     int lineOffset);\r
 103 }\r