Module java.scripting

Package javax.script

Class ScriptException

java.lang.Object

java.lang.Throwable

java.lang.Exception

javax.script.ScriptException

All Implemented Interfaces:

Serializable

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.

Since:

1.6

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ScriptException(Exception e)	Creates a ScriptException wrapping an Exception thrown by an underlying interpreter.
ScriptException(String s)	Creates a ScriptException with a String to be used in its message.
ScriptException(String message, String fileName, int lineNumber)	Creates a ScriptException with message, filename and linenumber to be used in error messages.
ScriptException(String message, String fileName, int lineNumber, int columnNumber)	ScriptException constructor specifying message, filename, line number and column number.

Method Summary

Modifier and Type	Method	Description
int	getColumnNumber()	Get the column number on which an error occurred.
String	getFileName()	Get the source of the script causing the error.
int	getLineNumber()	Get the line number on which an error occurred.
String	getMessage()	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.

Methods declared in class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ScriptException

public ScriptException(String s)

Creates a ScriptException with a String to be used in its message. Filename, and line and column numbers are unspecified.

Parameters:

s - The String to use in the message.

ScriptException

public ScriptException(Exception e)

Creates a ScriptException wrapping an Exception thrown by an underlying interpreter. Line and column numbers and filename are unspecified.

Parameters:

e - The wrapped Exception.

ScriptException

public ScriptException(String message,
                       String fileName,
                       int lineNumber)

Creates a ScriptException with message, filename and linenumber to be used in error messages.

Parameters:

message - The string to use in the message

fileName - The file or resource name describing the location of a script error causing the ScriptException to be thrown.

lineNumber - A line number describing the location of a script error causing the ScriptException to be thrown.

ScriptException

public ScriptException(String message,
                       String fileName,
                       int lineNumber,
                       int columnNumber)

ScriptException constructor specifying message, filename, line number and column number.

Parameters:

message - The message.

fileName - The filename

lineNumber - the line number.

columnNumber - the column number.

Method Detail

getMessage

public String getMessage()

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.

Overrides:

getMessage in class Throwable

Returns:

The error message.

getLineNumber

public int getLineNumber()

Get the line number on which an error occurred.

Returns:

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

getColumnNumber

public int getColumnNumber()

Get the column number on which an error occurred.

Returns:

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

getFileName

public String getFileName()

Get the source of the script causing the error.

Returns:

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.