|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.are.plugin.BasePlugin.ReporterCollection
public final class BasePlugin.ReporterCollection
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright for class bytecode |
protected ReporterReporting[] |
reporters
List of objects used for reporting. |
Fields inherited from interface com.ibm.are.report.Reporting |
---|
FORMAT_BINARY, FORMAT_HTML, FORMAT_PLAIN_TEXT, FORMAT_SERIALIZED, FORMAT_USER_DEFINED, FORMAT_XML, LEVEL_ERROR, LEVEL_INFO, LEVEL_NONE, LEVEL_WARNING, MAX_REPORT_DEPTH, MIN_REPORT_DEPTH |
Constructor Summary | |
---|---|
protected |
BasePlugin.ReporterCollection()
Constructs a new ReporterCollection object |
Method Summary | |
---|---|
void |
addReporter(ReporterReporting reporter)
Add a reporter to this group |
java.lang.Object |
getContents()
Retrieves the entire contents of the report. |
int |
getOutputFormat()
Retrieves the output format used for reporting |
com.ibm.are.report.Publisher |
publisher()
The Publisher that is to
be used when publishing this report. |
protected void |
pushReportsToCollector()
Pushes all reports out to the global report collector. |
void |
removeAllReporters()
Removes all reporters |
void |
removeReporter(java.lang.String className)
Removes all reporters whose class name matches the given class name |
void |
report(java.lang.String msg,
int depth)
Report a message at the given level in the reporting hierarchy. |
void |
report(java.lang.String msg,
java.lang.String errorLevel)
Report a message at the given error level during the runtime processing. |
void |
report(java.lang.String msg,
java.lang.String errorLevel,
com.ibm.are.autofix.FixAction fixAction)
Report a message at the given error level during the runtime processing, with info about how to fix the problem. |
void |
reportDetail(ProblemContext problemCtx,
java.lang.String msg,
java.lang.String errorLevel)
Report details for a problem at the given error level during the runtime processing. |
void |
reportError(java.lang.String msg)
Report an error message during the runtime processing. |
void |
reportError(java.lang.String msg,
com.ibm.are.autofix.FixAction fixAction)
Report an error message during the runtime processing, with info about how to fix the problem. |
void |
reportErrorDetail(ProblemContext problemCtx,
java.lang.String msg)
Report details of an error message during the runtime processing. |
void |
reportFinish(com.ibm.are.core.Element elem,
ResultInfo result)
Reports the result of the runtime processing for a plugin. |
void |
reportInfo(java.lang.String msg)
Report an informational message during the runtime processing. |
void |
reportInfo(java.lang.String msg,
com.ibm.are.autofix.FixAction fixAction)
Report an informational message during the runtime processing, with info about how to fix the problem. |
void |
reportInfoDetail(ProblemContext problemCtx,
java.lang.String msg)
Report details for an informational message during the runtime processing. |
void |
reportStart(com.ibm.are.core.Element elem)
Reports the start of a plugin |
void |
reportStatistic(java.lang.String description,
java.lang.Object value,
int depth)
Reports an interesting or very important statistic. |
void |
reportStep(java.lang.String msg)
Reports a new step in the runtime processing. |
void |
reportStepDetail(java.lang.String msg)
Reports a new step detail in the runtime processing. |
void |
reportSubStep(java.lang.String msg)
Reports a new sub step in the runtime processing. |
void |
reportSubStepDetail(java.lang.String msg)
Reports a new sub step detail in the runtime processing. |
void |
reportWarning(java.lang.String msg)
Report a warning message during the runtime processing. |
void |
reportWarning(java.lang.String msg,
com.ibm.are.autofix.FixAction fixAction)
Report a warning message during the runtime processing, with info about how to fix the problem. |
void |
reportWarningDetail(ProblemContext problemCtx,
java.lang.String msg)
Report details for a warning message during the runtime processing. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
protected ReporterReporting[] reporters
ReporterReporting
interface.
Constructor Detail |
---|
protected BasePlugin.ReporterCollection()
ReporterCollection
object
Method Detail |
---|
protected void pushReportsToCollector()
ReportCollector
public final void reportStatistic(java.lang.String description, java.lang.Object value, int depth)
reportStatistic
in interface StatusReporting
description
- A description of the statistic being reportedvalue
- The (statistic) value to reportdepth
- The depth in the status reporting hierarchy where the statistic will be reportedpublic final void reportInfo(java.lang.String msg)
reportInfo
in interface ReporterReporting
msg
- The message to printpublic final void reportInfo(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
reportInfo
in interface ReporterReporting
msg
- The message to printfixAction
- The info about how to fix the problem.public final void reportWarning(java.lang.String msg)
reportWarning
in interface ReporterReporting
msg
- The message to printpublic final void reportWarning(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
reportWarning
in interface ReporterReporting
msg
- The message to printfixAction
- The info about how to fix the problem.public final void reportError(java.lang.String msg)
reportError
in interface ReporterReporting
msg
- The message to printpublic final void reportError(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
reportError
in interface ReporterReporting
msg
- The message to printfixAction
- The info about how to fix the problem.public final void report(java.lang.String msg, java.lang.String errorLevel)
report
in interface ReporterReporting
msg
- The message to printerrorLevel
- The error level to use when reportingpublic final void report(java.lang.String msg, java.lang.String errorLevel, com.ibm.are.autofix.FixAction fixAction)
report
in interface ReporterReporting
msg
- The message to printerrorLevel
- The error level to use when reportingfixAction
- The info about how to fix the problem.public final void reportStep(java.lang.String msg)
reportStep
in interface StatusReporting
msg
- The message to reportpublic final void reportStepDetail(java.lang.String msg)
reportStepDetail
in interface StatusReporting
msg
- The message to reportpublic final void reportSubStep(java.lang.String msg)
reportSubStep
in interface StatusReporting
msg
- The message to reportpublic final void reportSubStepDetail(java.lang.String msg)
reportSubStepDetail
in interface StatusReporting
msg
- The message to reportpublic void addReporter(ReporterReporting reporter)
reporter
- The reporter to be addedpublic void removeReporter(java.lang.String className)
className
- The package and class name of the reporter to removepublic void removeAllReporters()
public final int getOutputFormat()
getOutputFormat
in interface ReporterReporting
public final void report(java.lang.String msg, int depth)
report
in interface StatusReporting
msg
- The message to printdepth
- The level within the reporting hierarchy. If this
parameter were set to 1 it would be equivalent to
invoking the StatusReporting.reportStep(String)
method.
The valid value ranges from MIN_REPORT_DEPTH (include) to
MAN_REPORT_DEPTH (include).public final void reportStart(com.ibm.are.core.Element elem)
reportStart
in interface StatusReporting
elem
- The plugin that is startingpublic final void reportFinish(com.ibm.are.core.Element elem, ResultInfo result)
reportFinish
in interface StatusReporting
result
- The resultpublic void reportDetail(ProblemContext problemCtx, java.lang.String msg, java.lang.String errorLevel)
reportDetail
in interface ReporterReporting
problemCtx
- The context of the problem for which the
details are being reported.msg
- The message to printerrorLevel
- The error level to use when reportingpublic void reportErrorDetail(ProblemContext problemCtx, java.lang.String msg)
reportErrorDetail
in interface ReporterReporting
problemCtx
- The context of the problem for which the
details are being reported.msg
- The message to printpublic void reportInfoDetail(ProblemContext problemCtx, java.lang.String msg)
reportInfoDetail
in interface ReporterReporting
problemCtx
- The context of the problem for which the
details are being reported.msg
- The message to printpublic void reportWarningDetail(ProblemContext problemCtx, java.lang.String msg)
reportWarningDetail
in interface ReporterReporting
problemCtx
- The context of the problem for which the
details are being reported.msg
- The message to printpublic java.lang.Object getContents()
getContents
in interface ReporterReporting
public com.ibm.are.report.Publisher publisher()
Publisher
that is to
be used when publishing this report.
publisher
in interface ReporterReporting
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |