|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ToolContext
This interface is to be implemented by tool environments. It provides a facilty by which various methods, in the metadata discovery service implementation, can report progress and log informational messages with the tool environment's logging and display facilities.
If any metadata service operation can't guarantee to execute in under 1-2 seconds then it must use a progress monitor to report progress. At the very minimum, the operation must report some meaningful message to the progress monitor, even if it cannot continuously update it.
Nested Class Summary | |
---|---|
static interface |
ToolContext.ProgressMonitor
If the discovery service can take more than 1 to 2 seconds to complete an operation, it should call methods on this interface to indicate how much work needs to be done, and the current progress in completing the work. |
Method Summary | |
---|---|
Logger |
getLogger()
Return a Logger instance that can be used to log tracking and diagnostic information from the discovery service. |
ToolContext.ProgressMonitor |
getProgressMonitor()
Return a ProgressMonitor instance that can be used to communicate progress being made on a long-running operation within the discovery service. |
Method Detail |
---|
Logger getLogger()
There is no guarantee as to the particular handlers that a tool environment has associated with the returned logger.
All Level.SEVERE
and
Level.WARNING
log records must be locale
specific. They must be separated to a ResourceBundle, translated, and
retrieved using the locale of the tool environment. All other log records
do not need to be localized.
Tool environments should not surface to the user directly any log records
that are not Level.SEVERE
or
Level.WARNING
. Such records should be directed
to some other output such as a log file.
null
Logger.ResourceBundle
,
MessageFormat
ToolContext.ProgressMonitor getProgressMonitor()
null
ProgressMonitor.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |