FileDocCategorySizeDatePackage
ScriptException.javaAPI DocJava SE 6 API4254Tue Jun 10 00:26:26 BST 2008javax.script

ScriptException

public class ScriptException extends Exception
The generic Exception class for the Scripting APIs. Checked exception types thrown by underlying scripting implementations must be wrapped in instances of ScriptException. The class has members to store line and column numbers and filenames if this information is available.
author
Mike Grogan
version
1.0
since
1.6

Fields Summary
private String
fileName
private int
lineNumber
private int
columnNumber
Constructors Summary
public ScriptException(String s)
Creates a ScriptException with a String to be used in its message. Filename, and line and column numbers are unspecified.

param
s The String to use in the message.

        super(s);
        fileName = null;
        lineNumber = -1;
        columnNumber = -1;
public ScriptException(Exception e)
Creates a ScriptException wrapping an Exception thrown by an underlying interpreter. Line and column numbers and filename are unspecified.

param
e The wrapped Exception.

        super(e);
        fileName = null;
        lineNumber = -1;
        columnNumber = -1;
public ScriptException(String message, String fileName, int lineNumber)
Creates a ScriptException with message, filename and linenumber to be used in error messages.

param
message The string to use in the message
param
fileName The file or resource name describing the location of a script error causing the ScriptException to be thrown.
param
lineNumber A line number describing the location of a script error causing the ScriptException to be thrown.

        super(message);
        this.fileName = fileName;
        this.lineNumber = lineNumber;
        this.columnNumber = -1;
public ScriptException(String message, String fileName, int lineNumber, int columnNumber)
ScriptException constructor specifying message, filename, line number and column number.

param
message The message.
param
fileName The filename
param
lineNumber the line number.
param
columnNumber the column number.

        super(message);
        this.fileName = fileName;
        this.lineNumber = lineNumber;
        this.columnNumber = columnNumber;
Methods Summary
public intgetColumnNumber()
Get the column number on which an error occurred.

return
The column number. Returns -1 if a column number is unavailable.

        return columnNumber;
public java.lang.StringgetFileName()
Get the source of the script causing the error.

return
The file name of the script or some other string describing the script source. May return some implementation-defined string such as <unknown> if a description of the source is unavailable.

        return fileName;
public intgetLineNumber()
Get the line number on which an error occurred.

return
The line number. Returns -1 if a line number is unavailable.

        return lineNumber;
public java.lang.StringgetMessage()
Returns a message containing the String passed to a constructor as well as line and column numbers and filename if any of these are known.

return
The error message.

        String ret = super.getMessage();
        if (fileName != null) {
            ret += (" in " + fileName);
            if (lineNumber != -1) {
                ret += " at line number " + lineNumber;
            }
            
            if (columnNumber != -1) {
                ret += " at column number " + columnNumber;
            }
        }
        
        return ret;