|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.actf.util.logging.AbstractReporter
org.eclipse.actf.validation.reports.ValidationReporter
public class ValidationReporter
used to store logged records for later retrieval. Records can be retreaved all at once or individually, sorted, and organized for a more readable report. This is also the class that should be used when using List-like GUI components for viewing reports.
Field Summary |
---|
Fields inherited from class org.eclipse.actf.util.logging.AbstractReporter |
---|
bundle, categories, CATEGORY_FORMATTER, categoryFormatter, defaultOutputLevel, errorLoggers, SOURCE_ID_MAP, sourceID |
Fields inherited from interface org.eclipse.actf.util.logging.IReporter |
---|
CONFIG, CONFIGURATION, DEFAULT_LEVEL, DETAIL, ERROR, INFO, KEYS, MAX_LEVEL, MIN_LEVEL, SEVERE, SYSTEM_FATAL, SYSTEM_NONFATAL, TRACE, UNKNOWN, USER, VALIDATION, WARNING |
Constructor Summary | |
---|---|
ValidationReporter()
create a new ValidationReporter |
Method Summary | |
---|---|
void |
addReportRecord(ValidationReportRecord record)
|
void |
addReportRecords(List records)
|
void |
close()
close processing |
void |
endReport()
ends a report started with startReport . |
void |
flush()
Flush any pending output |
int |
getDefaultOutputLevel()
get the default output level. |
String |
getLastReport()
get the last reported message |
int |
getRecordCount()
get the number of report records logged by this reporter |
ValidationReportRecord[] |
getRecords()
return all records logged by this reporter thus far |
boolean |
isOpen()
returns whether or not this reporter is open |
ValidationReportRecord[] |
lastReport()
|
void |
open()
Open for processing |
void |
report(int level,
String message,
Object[] values)
report the message at the given level with the given substitution values |
void |
report(int level,
String msg,
Throwable t)
reports an exception or error. This method can be used to direct the stack trace of the given throwable to the appropriate output for this reporter (e.g. a GUI text area or stream). The level of the throwable is determined by the specified level parameter. |
void |
reset()
reset the reporter. This method should clear all categories and all remaining buffers and report records. |
void |
setLastReport(String reportText)
set the last report on this reporter. |
void |
startReport(Object comp)
start a new report. |
Methods inherited from class org.eclipse.actf.util.logging.AbstractReporter |
---|
endCategory, endCategory, getCategory, getCategoryFormatter, getReporter, getResourceBundle, getSourceID, getSourceIDString, registerErrorLogger, report, report, report, report, report, setCategoryFormatter, setDefaultOutputLevel, setResourceBundle, setSourceID, startCategory, unregisterErrorLogger |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ValidationReporter()
Method Detail |
---|
public void open()
public boolean isOpen()
true
if has been opened, false
otherwiseIReporter.open()
public void close()
public void flush()
public void report(int level, String message, Object[] values)
IReporter.report(int, String)
public void report(int level, String msg, Throwable t)
report
in interface IReporter
report
in class AbstractReporter
level
- - level of exception or errormsg
- - optional messaget
- - Throwable being reportedpublic String getLastReport()
public void reset()
reset
in interface IReporter
reset
in class AbstractReporter
public ValidationReportRecord[] getRecords()
public int getRecordCount()
public void startReport(Object comp)
endReport
call.
comp
- - root component for which report is being generatedpublic void endReport()
startReport
. Once this method is called, the getLastReport
method can be called in order to supply the report generated betwen the startReport
call and
this call.
public ValidationReportRecord[] lastReport()
public void setLastReport(String reportText)
ValidationLauncher.DISTINCT_JVM
after the launcher gets an indication that a report has completed.
reportText
- - last report generatedpublic void addReportRecords(List records)
public int getDefaultOutputLevel()
getDefaultOutputLevel
in interface IReporter
getDefaultOutputLevel
in class AbstractReporter
IReporter.setDefaultOutputLevel(int)
public void addReportRecord(ValidationReportRecord record)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |