|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ReporterReporting
The ReporterReporting
interface defines the set of methods used for reporting problems in
the ARE environment. Problems can be reported at three different severity levels: error, warning, or info.
These differing levels give plugin authors the ability to assign a detected problem a level of severity, or
put another way a level of importance, when reporting the problem.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright for class bytecode |
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 |
Method Summary | |
---|---|
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. |
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 |
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 |
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 interface com.ibm.are.report.StatusReporting |
---|
report, reportFinish, reportStart, reportStatistic, reportStep, reportStepDetail, reportSubStep, reportSubStepDetail |
Field Detail |
---|
static final java.lang.String COPYRIGHT
Method Detail |
---|
int getOutputFormat()
void reportInfo(java.lang.String msg)
msg
- The message to printvoid reportInfo(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
msg
- The message to printfixAction
- The info about how to fix the problem.void reportWarning(java.lang.String msg)
msg
- The message to printvoid reportWarning(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
msg
- The message to printfixAction
- The info about how to fix the problem.void reportError(java.lang.String msg)
msg
- The message to printvoid reportError(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
msg
- The message to printfixAction
- The info about how to fix the problem.void report(java.lang.String msg, java.lang.String errorLevel)
msg
- The message to printerrorLevel
- The error level to use when reportingvoid report(java.lang.String msg, java.lang.String errorLevel, com.ibm.are.autofix.FixAction fixAction)
msg
- The message to printerrorLevel
- The error level to use when reportingfixAction
- The info about how to fix the problem.void reportInfoDetail(ProblemContext problemCtx, java.lang.String msg)
msg
- The message to printproblemCtx
- The context of the problem for which the
details are being reported.void reportWarningDetail(ProblemContext problemCtx, java.lang.String msg)
msg
- The message to printproblemCtx
- The context of the problem for which the
details are being reported.void reportErrorDetail(ProblemContext problemCtx, java.lang.String msg)
problemCtx
- The context of the problem for which the
details are being reported.msg
- The message to printvoid reportDetail(ProblemContext problemCtx, java.lang.String msg, java.lang.String errorLevel)
problemCtx
- The context of the problem for which the
details are being reported.msg
- The message to printerrorLevel
- The error level to use when reportingjava.lang.Object getContents()
com.ibm.are.report.Publisher publisher()
Publisher
that is to
be used when publishing this report.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |