Package sleep.error

Class SyntaxError


  • public class SyntaxError
    extends java.lang.Object
    A class containing syntax error information. A SyntaxError object is passed by a YourCodeSucksException.
    See Also:
    YourCodeSucksException
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String code  
      protected java.lang.String description  
      protected int lineNo  
      protected java.lang.String marker  
    • Constructor Summary

      Constructors 
      Constructor Description
      SyntaxError​(java.lang.String _description, java.lang.String _code, int _lineNo)
      construct a syntax error object, but enough about me...
      SyntaxError​(java.lang.String _description, java.lang.String _code, int _lineNo, java.lang.String _marker)
      construct a syntax error object, but enough about me...
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCodeSnippet()
      return an isolated snippet of code from where the error occured
      java.lang.String getDescription()
      return a best guess description of what the error in the code might actually be
      int getLineNumber()
      return the line number in the file where the error occured.
      java.lang.String getMarker()
      return a marker string
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • description

        protected java.lang.String description
      • code

        protected java.lang.String code
      • marker

        protected java.lang.String marker
      • lineNo

        protected int lineNo
    • Constructor Detail

      • SyntaxError

        public SyntaxError​(java.lang.String _description,
                           java.lang.String _code,
                           int _lineNo)
        construct a syntax error object, but enough about me... how about you?
      • SyntaxError

        public SyntaxError​(java.lang.String _description,
                           java.lang.String _code,
                           int _lineNo,
                           java.lang.String _marker)
        construct a syntax error object, but enough about me... how about you?
    • Method Detail

      • getMarker

        public java.lang.String getMarker()
        return a marker string
      • getDescription

        public java.lang.String getDescription()
        return a best guess description of what the error in the code might actually be
      • getCodeSnippet

        public java.lang.String getCodeSnippet()
        return an isolated snippet of code from where the error occured
      • getLineNumber

        public int getLineNumber()
        return the line number in the file where the error occured.