com.hcl.domino.exception

Class FormulaCompilationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.hcl.domino.DominoException

com.hcl.domino.exception.FormulaCompilationException

All Implemented Interfaces:

Serializable

public class FormulaCompilationException
extends DominoException

Subclass of DominoException that is thrown when formula compilation fails and that provides details about the error

Author:

Karsten Lehmann

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FormulaCompilationException(int id, String msg, String formula, String compileErrorReason, short compileErrorStatus, short compileErrorLine, short compileErrorColumn, short compileErrorOffset, short compileErrorLength) Creates a new instance

Method Summary

Modifier and Type	Method and Description
int	getCompileErrorColumn() Returns the column number where the error occurred
int	getCompileErrorLength() Returns the lengths of the error (probably the length of the error producing code)
int	getCompileErrorLine() Returns the line where the error occurred
int	getCompileErrorOffset() Returns the offset where the error occurred
String	getCompileErrorReason() Returns the detail info what is wrong in the formula
int	getCompileErrorReasonCode() Returns a numeric error code for the compile error
String	getFormula() Returns the formula that raised the error

Methods inherited from class com.hcl.domino.DominoException

getId

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FormulaCompilationException

public FormulaCompilationException(int id,
                                   String msg,
                                   String formula,
                                   String compileErrorReason,
                                   short compileErrorStatus,
                                   short compileErrorLine,
                                   short compileErrorColumn,
                                   short compileErrorOffset,
                                   short compileErrorLength)

Creates a new instance

Parameters:

id - error code for formula compilation, e.g. ERR_FORMULA_COMPILATION (1281)

msg - error message for formula compilation, e.g. "Formula Error"

formula - formula for which compilation failed

compileErrorReason - detail error describing what is wrong in the formula

compileErrorStatus - compile error reason status code

compileErrorLine - line number

compileErrorColumn - column number

compileErrorOffset - offset

compileErrorLength - length of error

Method Detail

getFormula

public String getFormula()

Returns the formula that raised the error

Returns:

formula

getCompileErrorReason

public String getCompileErrorReason()

Returns the detail info what is wrong in the formula

Returns:

error reason

getCompileErrorReasonCode

public int getCompileErrorReasonCode()

Returns a numeric error code for the compile error

Returns:

error reason code

getCompileErrorLine

public int getCompileErrorLine()

Returns the line where the error occurred

Returns:

line

getCompileErrorColumn

public int getCompileErrorColumn()

Returns the column number where the error occurred

Returns:

column

getCompileErrorOffset

public int getCompileErrorOffset()

Returns the offset where the error occurred

Returns:

offset

getCompileErrorLength

public int getCompileErrorLength()

Returns the lengths of the error (probably the length of the error producing code)

Returns:

length