ErrorDispatcher (Apache Tomcat 7.0.106 API Documentation)

java.lang.Object
- org.apache.jasper.compiler.ErrorDispatcher

```
public class ErrorDispatcher
extends java.lang.Object
```
Class responsible for dispatching JSP parse and javac compilation errors to the configured error handler. This class is also responsible for localizing any error codes before they are passed on to the configured error handler. In the case of a Java compilation error, the compiler error message is parsed into an array of JavacErrorDetail instances, which is passed on to the configured error handler.

Author:

Jan Luehe, Kin-man Chung

Constructor Summary

Constructors
Constructor and Description

ErrorDispatcher(boolean jspcMode)

Constructors
Constructor and Description
`ErrorDispatcher(boolean jspcMode)`

Method Summary

Methods
Modifier and Type	Method and Description
`static JavacErrorDetail`	`createJavacError(java.lang.String fname, org.apache.jasper.compiler.Node.Nodes page, java.lang.StringBuilder errMsgBuf, int lineNum)` Create a compilation error.
`static JavacErrorDetail`	`createJavacError(java.lang.String fname, org.apache.jasper.compiler.Node.Nodes page, java.lang.StringBuilder errMsgBuf, int lineNum, JspCompilationContext ctxt)` Create a compilation error.
`void`	`javacError(JavacErrorDetail[] javacErrors)` Dispatches the given javac compilation errors to the configured error handler.
`void`	`javacError(java.lang.String errorReport, java.lang.Exception e)` Dispatches the given compilation error report and exception to the configured error handler.
`void`	`jspError(java.lang.Exception e)` Dispatches the given parsing exception to the configured error handler.
`void`	`jspError(java.lang.Exception e, java.lang.String errCode, java.lang.String arg)`
`void`	`jspError(org.apache.jasper.compiler.Mark where, java.lang.Exception e, java.lang.String errCode, java.lang.String... args)`
`void`	`jspError(org.apache.jasper.compiler.Mark where, java.lang.String errCode)` Dispatches the given JSP parse error to the configured error handler.
`void`	`jspError(org.apache.jasper.compiler.Mark where, java.lang.String errCode, java.lang.String arg)` Dispatches the given JSP parse error to the configured error handler.
`void`	`jspError(org.apache.jasper.compiler.Mark where, java.lang.String errCode, java.lang.String arg1, java.lang.String arg2)` Dispatches the given JSP parse error to the configured error handler.
`void`	`jspError(org.apache.jasper.compiler.Mark where, java.lang.String errCode, java.lang.String arg1, java.lang.String arg2, java.lang.String arg3)` Dispatches the given JSP parse error to the configured error handler.
`void`	`jspError(org.apache.jasper.compiler.Node n, java.lang.Exception e, java.lang.String errCode, java.lang.String arg)` Dispatches the given JSP parse error to the configured error handler.
`void`	`jspError(org.apache.jasper.compiler.Node n, java.lang.String errCode)` Dispatches the given JSP parse error to the configured error handler.
`void`	`jspError(org.apache.jasper.compiler.Node n, java.lang.String errCode, java.lang.String arg)` Dispatches the given JSP parse error to the configured error handler.
`void`	`jspError(org.apache.jasper.compiler.Node n, java.lang.String errCode, java.lang.String arg, java.lang.Exception e)` Deprecated. Replaced by jspError(Node, Exception, String, String)
`void`	`jspError(org.apache.jasper.compiler.Node n, java.lang.String errCode, java.lang.String arg1, java.lang.String arg2)` Dispatches the given JSP parse error to the configured error handler.
`void`	`jspError(org.apache.jasper.compiler.Node n, java.lang.String errCode, java.lang.String arg1, java.lang.String arg2, java.lang.String arg3)` Dispatches the given JSP parse error to the configured error handler.
`void`	`jspError(java.lang.String errCode)` Dispatches the given JSP parse error to the configured error handler.
`void`	`jspError(java.lang.String errCode, java.lang.String arg)` Dispatches the given JSP parse error to the configured error handler.
`void`	`jspError(java.lang.String errCode, java.lang.String arg, java.lang.Exception e)` Deprecated. Replaced by jspError(Exception, String, String)
`void`	`jspError(java.lang.String errCode, java.lang.String arg1, java.lang.String arg2)` Dispatches the given JSP parse error to the configured error handler.
`void`	`jspError(java.lang.String errCode, java.lang.String arg1, java.lang.String arg2, java.lang.String arg3)` Dispatches the given JSP parse error to the configured error handler.
`static JavacErrorDetail[]`	`parseJavacErrors(java.lang.String errMsg, java.lang.String fname, org.apache.jasper.compiler.Node.Nodes page)` Parses the given error message into an array of javac compilation error messages (one per javac compilation error line number).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ErrorDispatcher
```
public ErrorDispatcher(boolean jspcMode)
```
- Method Detail
  - jspError
```
public void jspError(java.lang.String errCode)
              throws JasperException
```
    Dispatches the given JSP parse error to the configured error handler. The given error code is localized. If it is not found in the resource bundle for localized error messages, it is used as the error message.
    
    Parameters:
    errCode - Error code
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
public void jspError(org.apache.jasper.compiler.Mark where,
            java.lang.String errCode)
              throws JasperException
```
    Dispatches the given JSP parse error to the configured error handler. The given error code is localized. If it is not found in the resource bundle for localized error messages, it is used as the error message.
    
    Parameters:
    where - Error location
    errCode - Error code
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
public void jspError(org.apache.jasper.compiler.Node n,
            java.lang.String errCode)
              throws JasperException
```
    Dispatches the given JSP parse error to the configured error handler. The given error code is localized. If it is not found in the resource bundle for localized error messages, it is used as the error message.
    
    Parameters:
    n - Node that caused the error
    errCode - Error code
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
public void jspError(java.lang.String errCode,
            java.lang.String arg)
              throws JasperException
```
    Dispatches the given JSP parse error to the configured error handler. The given error code is localized. If it is not found in the resource bundle for localized error messages, it is used as the error message.
    
    Parameters:
    errCode - Error code
    arg - Argument for parametric replacement
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
public void jspError(org.apache.jasper.compiler.Mark where,
            java.lang.String errCode,
            java.lang.String arg)
              throws JasperException
```
    Dispatches the given JSP parse error to the configured error handler. The given error code is localized. If it is not found in the resource bundle for localized error messages, it is used as the error message.
    
    Parameters:
    where - Error location
    errCode - Error code
    arg - Argument for parametric replacement
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
public void jspError(org.apache.jasper.compiler.Node n,
            java.lang.String errCode,
            java.lang.String arg)
              throws JasperException
```
    Dispatches the given JSP parse error to the configured error handler. The given error code is localized. If it is not found in the resource bundle for localized error messages, it is used as the error message.
    
    Parameters:
    n - Node that caused the error
    errCode - Error code
    arg - Argument for parametric replacement
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
public void jspError(java.lang.String errCode,
            java.lang.String arg1,
            java.lang.String arg2)
              throws JasperException
```
    Dispatches the given JSP parse error to the configured error handler. The given error code is localized. If it is not found in the resource bundle for localized error messages, it is used as the error message.
    
    Parameters:
    errCode - Error code
    arg1 - First argument for parametric replacement
    arg2 - Second argument for parametric replacement
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
public void jspError(java.lang.String errCode,
            java.lang.String arg1,
            java.lang.String arg2,
            java.lang.String arg3)
              throws JasperException
```
    Dispatches the given JSP parse error to the configured error handler. The given error code is localized. If it is not found in the resource bundle for localized error messages, it is used as the error message.
    
    Parameters:
    errCode - Error code
    arg1 - First argument for parametric replacement
    arg2 - Second argument for parametric replacement
    arg3 - Third argument for parametric replacement
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
public void jspError(org.apache.jasper.compiler.Mark where,
            java.lang.String errCode,
            java.lang.String arg1,
            java.lang.String arg2)
              throws JasperException
```
    Dispatches the given JSP parse error to the configured error handler. The given error code is localized. If it is not found in the resource bundle for localized error messages, it is used as the error message.
    
    Parameters:
    where - Error location
    errCode - Error code
    arg1 - First argument for parametric replacement
    arg2 - Second argument for parametric replacement
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
public void jspError(org.apache.jasper.compiler.Mark where,
            java.lang.String errCode,
            java.lang.String arg1,
            java.lang.String arg2,
            java.lang.String arg3)
              throws JasperException
```
    Dispatches the given JSP parse error to the configured error handler. The given error code is localized. If it is not found in the resource bundle for localized error messages, it is used as the error message.
    
    Parameters:
    where - Error location
    errCode - Error code
    arg1 - First argument for parametric replacement
    arg2 - Second argument for parametric replacement
    arg3 - Third argument for parametric replacement
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
public void jspError(org.apache.jasper.compiler.Node n,
            java.lang.String errCode,
            java.lang.String arg1,
            java.lang.String arg2)
              throws JasperException
```
    Dispatches the given JSP parse error to the configured error handler. The given error code is localized. If it is not found in the resource bundle for localized error messages, it is used as the error message.
    
    Parameters:
    n - Node that caused the error
    errCode - Error code
    arg1 - First argument for parametric replacement
    arg2 - Second argument for parametric replacement
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
public void jspError(org.apache.jasper.compiler.Node n,
            java.lang.String errCode,
            java.lang.String arg1,
            java.lang.String arg2,
            java.lang.String arg3)
              throws JasperException
```
    Dispatches the given JSP parse error to the configured error handler. The given error code is localized. If it is not found in the resource bundle for localized error messages, it is used as the error message.
    
    Parameters:
    n - Node that caused the error
    errCode - Error code
    arg1 - First argument for parametric replacement
    arg2 - Second argument for parametric replacement
    arg3 - Third argument for parametric replacement
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
public void jspError(java.lang.Exception e)
              throws JasperException
```
    Dispatches the given parsing exception to the configured error handler.
    
    Parameters:
    e - Parsing exception
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
public void jspError(java.lang.Exception e,
            java.lang.String errCode,
            java.lang.String arg)
              throws JasperException
```
    Throws:
    
    JasperException
  - jspError
```
@Deprecated
public void jspError(java.lang.String errCode,
                       java.lang.String arg,
                       java.lang.Exception e)
              throws JasperException
```
    Deprecated. Replaced by jspError(Exception, String, String)
    
    Parameters:
    errCode - Error code
    arg - Argument for parametric replacement
    e - Parsing exception
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
public void jspError(org.apache.jasper.compiler.Mark where,
            java.lang.Exception e,
            java.lang.String errCode,
            java.lang.String... args)
              throws JasperException
```
    Throws:
    
    JasperException
  - jspError
```
public void jspError(org.apache.jasper.compiler.Node n,
            java.lang.Exception e,
            java.lang.String errCode,
            java.lang.String arg)
              throws JasperException
```
    Dispatches the given JSP parse error to the configured error handler. The given error code is localized. If it is not found in the resource bundle for localized error messages, it is used as the error message.
    
    Parameters:
    n - Node that caused the error
    e - Parsing exception
    errCode - Error code
    arg - Argument for parametric replacement
    
    Throws:
    
    JasperException - An error occurred
  - jspError
```
@Deprecated
public void jspError(org.apache.jasper.compiler.Node n,
                       java.lang.String errCode,
                       java.lang.String arg,
                       java.lang.Exception e)
              throws JasperException
```
    Deprecated. Replaced by jspError(Node, Exception, String, String)
    
    Parameters:
    n - Node that caused the error
    errCode - Error code
    arg - Argument for parametric replacement
    e - Parsing exception
    
    Throws:
    
    JasperException - An error occurred
  - parseJavacErrors
```
public static JavacErrorDetail[] parseJavacErrors(java.lang.String errMsg,
                                  java.lang.String fname,
                                  org.apache.jasper.compiler.Node.Nodes page)
                                           throws JasperException,
                                                  java.io.IOException
```
    Parses the given error message into an array of javac compilation error messages (one per javac compilation error line number).
    
    Parameters:
    errMsg - Error message
    fname - Name of Java source file whose compilation failed
    page - Node representation of JSP page from which the Java source file was generated
    
    Returns:
    Array of javac compilation errors, or null if the given error message does not contain any compilation error line numbers
    
    Throws:
    
    JasperException - An error occurred
    
    java.io.IOException - IO error which usually should not occur
  - javacError
```
public void javacError(JavacErrorDetail[] javacErrors)
                throws JasperException
```
    Dispatches the given javac compilation errors to the configured error handler.
    
    Parameters:
    javacErrors - Array of javac compilation errors
    
    Throws:
    
    JasperException - An error occurred
  - javacError
```
public void javacError(java.lang.String errorReport,
              java.lang.Exception e)
                throws JasperException
```
    Dispatches the given compilation error report and exception to the configured error handler.
    
    Parameters:
    errorReport - Compilation error report
    e - Compilation exception
    
    Throws:
    
    JasperException - An error occurred
  - createJavacError
```
public static JavacErrorDetail createJavacError(java.lang.String fname,
                                org.apache.jasper.compiler.Node.Nodes page,
                                java.lang.StringBuilder errMsgBuf,
                                int lineNum)
                                         throws JasperException
```
    Create a compilation error.
    
    Parameters:
    fname - The file name
    page - The page nodes
    errMsgBuf - The error message
    lineNum - The source line number of the error
    
    Returns:
    JavacErrorDetail The error details
    
    Throws:
    
    JasperException - An error occurred
  - createJavacError
```
public static JavacErrorDetail createJavacError(java.lang.String fname,
                                org.apache.jasper.compiler.Node.Nodes page,
                                java.lang.StringBuilder errMsgBuf,
                                int lineNum,
                                JspCompilationContext ctxt)
                                         throws JasperException
```
    Create a compilation error.
    
    Parameters:
    fname - The file name
    page - The page nodes
    errMsgBuf - The error message
    lineNum - The source line number of the error
    ctxt - The compilation context
    
    Returns:
    JavacErrorDetail The error details
    
    Throws:
    
    JasperException - An error occurred

Class ErrorDispatcher

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ErrorDispatcher

Method Detail

jspError

jspError

jspError

jspError

jspError

jspError

jspError

jspError

jspError

jspError

jspError

jspError

jspError

jspError

jspError

jspError

jspError

jspError

parseJavacErrors

javacError

javacError

createJavacError

createJavacError