org.neuzd.Regnus
Class Debugger

java.lang.Object
  extended by org.neuzd.Regnus.Debugger

public class Debugger
extends java.lang.Object

A utility class that verifies the syntax of Regnus Script File and provides methods to retrieve the details of the errors eventually found in the script.

Version:
1.0
Author:
neuzd

Constructor Summary
Debugger()
          Creates a Debugger class.
 
Method Summary
 java.lang.String getDisplayText()
          Creates a String with the details of the errors found in the script.
 int getErrorsCount()
          Counts the number of errors found in the script.
 void performDebug(java.lang.String RSFFile)
          Performs the debugging of a Regnus Script File.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Debugger

public Debugger()
Creates a Debugger class.

Method Detail

getDisplayText

public java.lang.String getDisplayText()
Creates a String with the details of the errors found in the script. Contains the text "Script is OK" if no errors are found.

Returns:
a String containing the details of the errors found in the script

getErrorsCount

public int getErrorsCount()
Counts the number of errors found in the script.

Returns:
an int representing the number of total errors found in the script

performDebug

public void performDebug(java.lang.String RSFFile)
                  throws java.lang.Exception
Performs the debugging of a Regnus Script File.

Parameters:
RSFFile - the absolute path of the Regnus Script File
Throws:
java.lang.Exception