railo.runtime.debug
Interface Debugger

All Known Subinterfaces:
DebuggerPro
All Known Implementing Classes:
DebuggerImpl

public interface Debugger

debugger interface


Method Summary
 void addException(Config config, PageException pe)
           
 void addImplicitAccess(String scope, String name)
           
 void addQuery(Query query, String datasource, String name, SQL sql, int recordcount, PageSource src, int time)
          add new query execution time
 DebugTimer addTimer(String label, long exe, String template)
          adds ne Timer info to debug
 DebugTrace addTrace(int type, String category, String text, PageSource page, String varName, String varValue)
          add new Trace to debug
 DebugTrace addTrace(int type, String category, String text, String template, int line, String action, String varName, String varValue)
           
 Struct getDebuggingData(PageContext pc)
          returns the Debugging Info
 Struct getDebuggingData(PageContext pc, boolean addAddionalInfo)
           
 DebugEntryTemplate getEntry(PageContext pc, PageSource source)
           
 DebugEntryTemplatePart getEntry(PageContext pc, PageSource source, int startPos, int endPos)
          returns a single DebugEntry for a specific postion (startPos,endPos in the PageSource)
 DebugEntryTemplate getEntry(PageContext pc, PageSource source, String key)
           
 CatchBlock[] getExceptions()
           
 ImplicitAccess[] getImplicitAccesses(int scope, String name)
           
 List<QueryEntry> getQueries()
           
 DebugTrace[] getTraces()
           
 void reset()
          reset the debug object
 void setOutput(boolean output)
          sets if toHTML print html output info or not
 void writeOut(PageContext pc)
           
 

Method Detail

reset

void reset()
reset the debug object


getEntry

DebugEntryTemplate getEntry(PageContext pc,
                            PageSource source)
Parameters:
pc - current PagContext
source - Page Source for the entry
Returns:
returns a single DebugEntry

getEntry

DebugEntryTemplate getEntry(PageContext pc,
                            PageSource source,
                            String key)
Parameters:
pc - current PagContext
source - Page Source for the entry
key -
Returns:
returns a single DebugEntry with a key

getEntry

DebugEntryTemplatePart getEntry(PageContext pc,
                                PageSource source,
                                int startPos,
                                int endPos)
returns a single DebugEntry for a specific postion (startPos,endPos in the PageSource)

Parameters:
pc - current PagContext
source - Page Source for the entry
startPos - start position in the file
endPos - end position in the file
Returns:

addQuery

void addQuery(Query query,
              String datasource,
              String name,
              SQL sql,
              int recordcount,
              PageSource src,
              int time)
add new query execution time

Parameters:
query -
datasource -
name -
sql -
recordcount -
src -
time -

setOutput

void setOutput(boolean output)
sets if toHTML print html output info or not

Parameters:
output - The output to set.

getQueries

List<QueryEntry> getQueries()
Returns:
Returns the queries.

writeOut

void writeOut(PageContext pc)
              throws IOException
Parameters:
pc -
Throws:
IOException

getDebuggingData

Struct getDebuggingData(PageContext pc)
                        throws PageException
returns the Debugging Info

Returns:
debugging Info
Throws:
PageException

getDebuggingData

Struct getDebuggingData(PageContext pc,
                        boolean addAddionalInfo)
                        throws PageException
Throws:
PageException

addTimer

DebugTimer addTimer(String label,
                    long exe,
                    String template)
adds ne Timer info to debug

Parameters:
label -
exe -

addTrace

DebugTrace addTrace(int type,
                    String category,
                    String text,
                    PageSource page,
                    String varName,
                    String varValue)
add new Trace to debug

Parameters:
type -
category -
text -
page -
varName -
varValue -
Returns:
debug trace object

addTrace

DebugTrace addTrace(int type,
                    String category,
                    String text,
                    String template,
                    int line,
                    String action,
                    String varName,
                    String varValue)

getTraces

DebugTrace[] getTraces()

addException

void addException(Config config,
                  PageException pe)

getExceptions

CatchBlock[] getExceptions()

addImplicitAccess

void addImplicitAccess(String scope,
                       String name)

getImplicitAccesses

ImplicitAccess[] getImplicitAccesses(int scope,
                                     String name)


Copyright © 2012 Railo