Package com.nomagic.magicdraw.utils.parsers

Class ParseException

  • All Implemented Interfaces:
    java.io.Serializable
    @OpenApiAll
public class ParseException
extends java.lang.Exception
    This exception is thrown when parse errors are encountered. You can explicitly create objects of this exception type by calling the method generateParseException in the generated parser. You can modify this class to customize your error reporting mechanisms so long as you retain the public fields.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Token currentToken
      This is the last token that has been consumed successfully.
      private java.lang.String eol
      The end of line string for this machine.
      private int[][] expectedTokenSequences
      Each entry in this array is an array of integers.
      private static long serialVersionUID
      The version identifier for this Serializable class.
      private java.lang.String[] tokenImage
      This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred.

    • Constructor Summary

      Constructors 
      Constructor Description
      ParseException()
      The following constructors are for use by you for whatever purpose you can think of.
      ParseException​(Token currentTokenVal, int[][] expectedTokenSequencesVal, java.lang.String[] tokenImageVal)
      This constructor is used by the method "generateParseException" in the generated parser.
      ParseException​(java.lang.String message)
      Constructor with message.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      (package private) static java.lang.String add_escapes​(java.lang.String str)
      Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal.
      Token getCurrentToken()  
      java.lang.String getEol()  
      int[][] getExpectedTokenSequences()  
      java.lang.String[] getTokenImage()  
      private static java.lang.String initialise​(Token currentToken, int[][] expectedTokenSequences, java.lang.String[] tokenImage)
      It uses "currentToken" and "expectedTokenSequences" to generate a parse error message and returns it.

      • 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

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        The version identifier for this Serializable class. Increment only if the serialized form of the class changes.
        See Also:
        Constant Field Values

      • currentToken

        private Token currentToken
        This is the last token that has been consumed successfully. If this object has been created due to a parse error, the token following this token will (therefore) be the first error token.

      • expectedTokenSequences

        private int[][] expectedTokenSequences
        Each entry in this array is an array of integers. Each array of integers represents a sequence of tokens (by their ordinal values) that is expected at this point of the parse.

      • tokenImage

        private java.lang.String[] tokenImage
        This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred. This array is defined in the generated ...Constants interface.

      • eol

        private final java.lang.String eol
        The end of line string for this machine.

    • Constructor Detail

      • ParseException

        public ParseException​(Token currentTokenVal,
                      int[][] expectedTokenSequencesVal,
                      java.lang.String[] tokenImageVal)
        This constructor is used by the method "generateParseException" in the generated parser. Calling this constructor generates a new object of this type with the fields "currentToken", "expectedTokenSequences", and "tokenImage" set.

      • ParseException

        public ParseException()
        The following constructors are for use by you for whatever purpose you can think of. Constructing the exception in this manner makes the exception behave in the normal way - i.e., as documented in the class "Throwable". The fields "errorToken", "expectedTokenSequences", and "tokenImage" do not contain relevant information. The JavaCC generated code does not use these constructors.

      • ParseException

        public ParseException​(java.lang.String message)
        Constructor with message.

    • Method Detail

      • initialise

        private static java.lang.String initialise​(Token currentToken,
                                           int[][] expectedTokenSequences,
                                           java.lang.String[] tokenImage)
        It uses "currentToken" and "expectedTokenSequences" to generate a parse error message and returns it. If this object has been created due to a parse error, and you do not catch it (it gets thrown from the parser) the correct error message gets displayed.

      • add_escapes

        static java.lang.String add_escapes​(java.lang.String str)
        Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal.

      • getCurrentToken

        public Token getCurrentToken()

      • getExpectedTokenSequences

        public int[][] getExpectedTokenSequences()

      • getTokenImage

        public java.lang.String[] getTokenImage()

      • getEol

        public java.lang.String getEol()