Showing the changes to java/pkg/javax/script/ScriptException.java (1 of 18352 files). Show all
Unified · Split
| @@ -0,0 +1,152 @@ | ||
| 1 | +/* | |
| 2 | + * Copyright (c) 2005, 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.script; | |
| 27 | + | |
| 28 | +/** | |
| 29 | + * The generic <code>Exception</code> class for the Scripting APIs. Checked | |
| 30 | + * exception types thrown by underlying scripting implementations must be wrapped in instances of | |
| 31 | + * <code>ScriptException</code>. The class has members to store line and column numbers and | |
| 32 | + * filenames if this information is available. | |
| 33 | + * | |
| 34 | + * @author Mike Grogan | |
| 35 | + * @since 1.6 | |
| 36 | + */ | |
| 37 | +public class ScriptException extends Exception { | |
| 38 | + | |
| 39 | + private String fileName; | |
| 40 | + private int lineNumber; | |
| 41 | + private int columnNumber; | |
| 42 | + | |
| 43 | + /** | |
| 44 | + * Creates a <code>ScriptException</code> with a String to be used in its message. | |
| 45 | + * Filename, and line and column numbers are unspecified. | |
| 46 | + * | |
| 47 | + * @param s The String to use in the message. | |
| 48 | + */ | |
| 49 | + public ScriptException(String s) { | |
| 50 | + super(s); | |
| 51 | + fileName = null; | |
| 52 | + lineNumber = -1; | |
| 53 | + columnNumber = -1; | |
| 54 | + } | |
| 55 | + | |
| 56 | + /** | |
| 57 | + * Creates a <code>ScriptException</code> wrapping an <code>Exception</code> thrown by an underlying | |
| 58 | + * interpreter. Line and column numbers and filename are unspecified. | |
| 59 | + * | |
| 60 | + * @param e The wrapped <code>Exception</code>. | |
| 61 | + */ | |
| 62 | + public ScriptException(Exception e) { | |
| 63 | + super(e); | |
| 64 | + fileName = null; | |
| 65 | + lineNumber = -1; | |
| 66 | + columnNumber = -1; | |
| 67 | + } | |
| 68 | + | |
| 69 | + /** | |
| 70 | + * Creates a <code>ScriptException</code> with message, filename and linenumber to | |
| 71 | + * be used in error messages. | |
| 72 | + * | |
| 73 | + * @param message The string to use in the message | |
| 74 | + * | |
| 75 | + * @param fileName The file or resource name describing the location of a script error | |
| 76 | + * causing the <code>ScriptException</code> to be thrown. | |
| 77 | + * | |
| 78 | + * @param lineNumber A line number describing the location of a script error causing | |
| 79 | + * the <code>ScriptException</code> to be thrown. | |
| 80 | + */ | |
| 81 | + public ScriptException(String message, String fileName, int lineNumber) { | |
| 82 | + super(message); | |
| 83 | + this.fileName = fileName; | |
| 84 | + this.lineNumber = lineNumber; | |
| 85 | + this.columnNumber = -1; | |
| 86 | + } | |
| 87 | + | |
| 88 | + /** | |
| 89 | + * <code>ScriptException</code> constructor specifying message, filename, line number | |
| 90 | + * and column number. | |
| 91 | + * @param message The message. | |
| 92 | + * @param fileName The filename | |
| 93 | + * @param lineNumber the line number. | |
| 94 | + * @param columnNumber the column number. | |
| 95 | + */ | |
| 96 | + public ScriptException(String message, | |
| 97 | + String fileName, | |
| 98 | + int lineNumber, | |
| 99 | + int columnNumber) { | |
| 100 | + super(message); | |
| 101 | + this.fileName = fileName; | |
| 102 | + this.lineNumber = lineNumber; | |
| 103 | + this.columnNumber = columnNumber; | |
| 104 | + } | |
| 105 | + | |
| 106 | + /** | |
| 107 | + * Returns a message containing the String passed to a constructor as well as | |
| 108 | + * line and column numbers and filename if any of these are known. | |
| 109 | + * @return The error message. | |
| 110 | + */ | |
| 111 | + public String getMessage() { | |
| 112 | + String ret = super.getMessage(); | |
| 113 | + if (fileName != null) { | |
| 114 | + ret += (" in " + fileName); | |
| 115 | + if (lineNumber != -1) { | |
| 116 | + ret += " at line number " + lineNumber; | |
| 117 | + } | |
| 118 | + | |
| 119 | + if (columnNumber != -1) { | |
| 120 | + ret += " at column number " + columnNumber; | |
| 121 | + } | |
| 122 | + } | |
| 123 | + | |
| 124 | + return ret; | |
| 125 | + } | |
| 126 | + | |
| 127 | + /** | |
| 128 | + * Get the line number on which an error occurred. | |
| 129 | + * @return The line number. Returns -1 if a line number is unavailable. | |
| 130 | + */ | |
| 131 | + public int getLineNumber() { | |
| 132 | + return lineNumber; | |
| 133 | + } | |
| 134 | + | |
| 135 | + /** | |
| 136 | + * Get the column number on which an error occurred. | |
| 137 | + * @return The column number. Returns -1 if a column number is unavailable. | |
| 138 | + */ | |
| 139 | + public int getColumnNumber() { | |
| 140 | + return columnNumber; | |
| 141 | + } | |
| 142 | + | |
| 143 | + /** | |
| 144 | + * Get the source of the script causing the error. | |
| 145 | + * @return The file name of the script or some other string describing the script | |
| 146 | + * source. May return some implementation-defined string such as <i><unknown></i> | |
| 147 | + * if a description of the source is unavailable. | |
| 148 | + */ | |
| 149 | + public String getFileName() { | |
| 150 | + return fileName; | |
| 151 | + } | |
| 152 | +} | |