intradoc.common
Class ParseSyntaxException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--intradoc.common.ParseSyntaxException

All Implemented Interfaces:

java.io.Serializable

public class ParseSyntaxException

extends java.lang.Exception

Reports not only a message but file, line, and column where it occurs.

See Also:

Serialized Form

Field Summary

boolean	m_outerOffsetsUsed Typically ParseSyntaxExceptions are thrown up a nested chain.
ParseLocationInfo	m_parseInfo Relative location of error.

Constructor Summary

ParseSyntaxException()

ParseSyntaxException(ParseLocationInfo parseInfo, java.lang.String msg)

ParseSyntaxException(ParseLocationInfo parseInfo, java.lang.String msg, boolean outerOffsetsUsed)

Method Summary

java.lang.String

createMessage(java.lang.String msg, java.lang.String parseStr)

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

m_parseInfo

public ParseLocationInfo m_parseInfo

Relative location of error.

m_outerOffsetsUsed

public boolean m_outerOffsetsUsed

Typically ParseSyntaxExceptions are thrown up a nested chain. For example, a script may appear inside of an include that has a 'eval' function surrounding it. Normally, as the exceptions are thrown up the wrapping, the cumulative offsets are combined. However, sometimes the inner script will already know some of the offsets of the outer script, in which case the outer script should not alter the offsets. This attribute is currently used only when parsing the script (not when executing) and only when validating GrammarElements after they have been parsed. When the GrammerElement is created it already has full offset (relative to the context in which it was parsed) information in it so that during execution, errors can be cleanly reported, but if a parsing error happens after the creation of the GrammerElement and uses the GrammarElement for its offsets, then the caller of the method parsing the string should not adjust the offsets.

Constructor Detail

ParseSyntaxException

public ParseSyntaxException()

ParseSyntaxException

public ParseSyntaxException(ParseLocationInfo parseInfo,
                            java.lang.String msg)

ParseSyntaxException

public ParseSyntaxException(ParseLocationInfo parseInfo,
                            java.lang.String msg,
                            boolean outerOffsetsUsed)

Method Detail

createMessage

public java.lang.String createMessage(java.lang.String msg,
                                      java.lang.String parseStr)
                               throws java.lang.IllegalArgumentException

java.lang.IllegalArgumentException