Package de.intarsys.tools.reporter
Interface IReporter
-
- All Known Implementing Classes:
DefaultReporter
,NullReporter
,ReplayReporter
,ReportDispatcher
public interface IReporter
An interface to report different types of information to the user.This may be implemented for example as pure logging in a headless environment or with message dialogs in a window system.
-
-
Field Summary
Fields Modifier and Type Field Description static int
STYLE_BEEP
static int
STYLE_NONE
static int
STYLE_STANDALONE
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
reportActivityEnd()
Indicate the end of an activity.void
reportActivityStart(java.lang.String message, int style)
Indicate the beginning of an activity, possibly blocking system interaction.void
reportError(java.lang.String title, java.lang.String message, java.lang.Throwable t, int style)
Indicate an error condition.void
reportMessage(java.lang.String title, java.lang.String message, int style)
Report a message to the user.void
reportProgress(java.lang.String message, int percent, int style)
Indicate the progress of an ongoing activity.void
reportStatus(java.lang.String message, int style)
Report a simple state information.
-
-
-
Field Detail
-
STYLE_NONE
static final int STYLE_NONE
- See Also:
- Constant Field Values
-
STYLE_STANDALONE
static final int STYLE_STANDALONE
- See Also:
- Constant Field Values
-
STYLE_BEEP
static final int STYLE_BEEP
- See Also:
- Constant Field Values
-
-
Method Detail
-
reportActivityEnd
void reportActivityEnd()
Indicate the end of an activity.
-
reportActivityStart
void reportActivityStart(java.lang.String message, int style)
Indicate the beginning of an activity, possibly blocking system interaction.- Parameters:
message
- A label for reporting the activity.style
-
-
reportError
void reportError(java.lang.String title, java.lang.String message, java.lang.Throwable t, int style)
Indicate an error condition. This method will return normally after a possible user interaction, any error handling is still up to the caller.- Parameters:
title
-message
-t
-style
-
-
reportMessage
void reportMessage(java.lang.String title, java.lang.String message, int style)
Report a message to the user. The message should be displayed in a blocking way in an interactive system.- Parameters:
title
-message
-style
-
-
reportProgress
void reportProgress(java.lang.String message, int percent, int style)
Indicate the progress of an ongoing activity. The activity will probably run concurrently.- Parameters:
message
-percent
-style
-
-
reportStatus
void reportStatus(java.lang.String message, int style)
Report a simple state information. This should not block the system in any way.- Parameters:
message
-style
-
-
-