|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IReporter
interface to be implemented in order to generate reports for tracing or validation during the execution of
the ACTF application. Typically, reports are configured with a stream or socket but see the
RecordReporter
, which can be used to store generated reports for later organization.
Field Summary | |
---|---|
static int |
CONFIG
|
static String |
CONFIGURATION
|
static int |
DEFAULT_LEVEL
|
static int |
DETAIL
|
static int |
ERROR
|
static int |
INFO
|
static String[] |
KEYS
|
static int |
MAX_LEVEL
|
static int |
MIN_LEVEL
|
static int |
SEVERE
|
static String |
SYSTEM_FATAL
|
static String |
SYSTEM_NONFATAL
|
static String |
TRACE
|
static int |
UNKNOWN
|
static String |
USER
|
static String |
VALIDATION
|
static int |
WARNING
|
Method Summary | |
---|---|
void |
close()
close processing |
void |
endCategory()
end the current reporting category |
void |
endCategory(String id)
end the category with the given id |
void |
endReport()
ends a report started with startReport . |
void |
flush()
Flush any pending output |
String |
getCategory()
get the category id string of current reporting |
int |
getDefaultOutputLevel()
get the default output level. |
String |
getLastReport()
get the last reported message |
String |
getSourceID()
gets the id or name of this reporter |
boolean |
isOpen()
returns whether or not this reporter is open |
void |
open()
Open for processing |
void |
registerErrorLogger(IErrorLogger logger)
add an error logger to the list of loggers to receive requests to report errors from this reporter. |
void |
report(int level,
String message)
report the message at the given level. |
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. |
void |
report(int level,
Throwable t)
reports an exception or error. |
void |
report(String message)
report the message |
void |
report(String message,
Object[] values)
report an information message using the substitution values |
void |
report(Throwable t)
reports an exception or error. |
void |
reset()
reset the reporter. |
void |
setDefaultOutputLevel(int level)
set the default output level. |
void |
setLastReport(String reportText)
set the last report on this reporter. |
void |
setSourceID(String name)
set the source id for future reports. |
void |
startCategory(String id)
start a new category with the given id. |
void |
startReport(Object comp)
start a new report. |
void |
unregisterErrorLogger(IErrorLogger logger)
remove an error logger from the list of loggers to receive errors |
Field Detail |
---|
static final int SEVERE
static final int ERROR
static final int WARNING
static final int INFO
static final int DETAIL
static final int CONFIG
static final int UNKNOWN
static final int DEFAULT_LEVEL
static final int MAX_LEVEL
static final int MIN_LEVEL
static final String[] KEYS
static final String VALIDATION
static final String SYSTEM_FATAL
static final String SYSTEM_NONFATAL
static final String USER
static final String TRACE
static final String CONFIGURATION
Method Detail |
---|
void setDefaultOutputLevel(int level)
level
- - default output levelint getDefaultOutputLevel()
setDefaultOutputLevel(int)
void open()
boolean isOpen()
true
if has been opened, false
otherwiseopen()
void close()
void flush()
void report(String message)
message
- -- message to be writtenvoid report(String message, Object[] values)
message
- -- message to be reportedvalues
- -- substitution valuesvoid report(int level, String message)
level
- -- level of messagemessage
- -- message to be reportedvoid report(int level, String message, Object[] values)
level
- message
- values
- report(int, String)
String getLastReport()
String getCategory()
void startCategory(String id)
id
- -- new category idvoid endCategory()
void endCategory(String id)
id
- -- id of category to endvoid registerErrorLogger(IErrorLogger logger)
logger
- - error logger for reporting errorsvoid unregisterErrorLogger(IErrorLogger logger)
logger
- - error logger to be removedvoid setSourceID(String name)
The id can be one of the following:
VALIDATION
- validation violation
USER
- user error (i.e. can be remedied by user)
SYSTEM_FATAL
- fatal system error (e.g. resource not found)
SYSTEM_NONFATAL
- nonfatal system error (i.e. process can continue but results are suspect)
TRACE
- message related to tracing or debugging
CONFIGURATION
- message related to configuration
name
- - name or id of this reporterString getSourceID()
setSourceID(String)
void report(Throwable t)
The default level of this report message is Reporter.SEVERE
.
t
- - Throwable being reportedvoid report(int level, Throwable t)
level
- - level of exception or errort
- - Throwable being reportedvoid report(int level, String msg, Throwable t)
level
- - level of exception or errormsg
- - optional messaget
- - Throwable being reportedvoid startReport(Object comp)
endReport
call.
comp
- - root component for which report is being generatedvoid 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.
void setLastReport(String reportText)
ValidationLauncher.DISTINCT_JVM
after the launcher gets an indication that a report has completed.
reportText
- - last report generatedvoid reset()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |