sleep.error
Class SyntaxError

java.lang.Object
  extended bysleep.error.SyntaxError

public class SyntaxError
extends Object

A class containing syntax error information. A SyntaxError object is passed by a YourCodeSucksException.

See Also:
YourCodeSucksException

Field Summary
protected  String code
           
protected  String description
           
protected  int lineNo
           
protected  String marker
           
 
Constructor Summary
SyntaxError(String _description, String _code, int _lineNo)
          construct a syntax error object, but enough about me...
SyntaxError(String _description, String _code, int _lineNo, String _marker)
          construct a syntax error object, but enough about me...
 
Method Summary
 String getCodeSnippet()
          return an isolated snippet of code from where the error occured
 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.
 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 String description

code

protected String code

marker

protected String marker

lineNo

protected int lineNo
Constructor Detail

SyntaxError

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


SyntaxError

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

Method Detail

getMarker

public String getMarker()
return a marker string


getDescription

public String getDescription()
return a best guess description of what the error in the code might actually be


getCodeSnippet

public 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.