net.sourceforge.buildmonitor
Interface BuildMonitor

All Known Implementing Classes:

BuildMonitorImpl

public interface BuildMonitor

Field Summary

static java.lang.String	MESSAGEKEY_ERROR_DIALOG_TITLE
static java.lang.String	MESSAGEKEY_ERROR_SYSTEMTRAY_NOT_SUPPORTED
static java.lang.String	MESSAGEKEY_TRAYICON_INITIAL_TOOLTIP
static java.lang.String	MESSAGEKEY_TRAYICON_MENU_EXIT
static java.lang.String	MESSAGEKEY_TRAYICON_MENU_SORT
static java.lang.String	MESSAGEKEY_TRAYICON_MENUITEM_ABOUT
static java.lang.String	MESSAGEKEY_TRAYICON_MENUITEM_BUILD_SERVER_HOME_PAGE_SUFFIX
static java.lang.String	MESSAGEKEY_TRAYICON_MENUITEM_EXIT
static java.lang.String	MESSAGEKEY_TRAYICON_MENUITEM_OPTIONS
static java.lang.String	MESSAGEKEY_TRAYICON_MENUITEM_SORT_BY_AGE
static java.lang.String	MESSAGEKEY_TRAYICON_MENUITEM_SORT_BY_NAME
static java.lang.String	MESSAGEKEY_TRAYICON_MENUITEM_UPDATE_STATUS_NOW
static java.lang.String	MESSAGEKEY_UNEXPECTED_ERROR_MESSAGE

Method Summary

java.awt.Image	getDialogsDefaultIcon() Returns the default icon to be displayed by dialogs opened by monitors
java.lang.String	getMessage(java.lang.String theMessageKey) Get a message identified by its key in the application resource bundle.
void	panic(java.lang.String theErrorMessage) The method to call when an unrecoverable error occurs in the application and you want to display your own message (instead of a generic one).It displays your error message to the end user and then exit.
void	panic(java.lang.Throwable theUnexpectedProblem) The method to call when an unrecoverable error occurs in the application.
void	reportConfigurationUpdatedToBeTakenIntoAccountImmediately() Report an update of the monitor configuration to be taken into account immediately
void	reportMonitoringException(MonitoringException theMonitoringException) Report a monitoring exception (this method is called by build monitors to notify that a monitoring exception occured)
void	updateBuildStatus(java.util.List<BuildReport> theBuildsStatus) Update the build status (this method is called by build monitors to update the GUI when the build status has changed).

Field Detail

MESSAGEKEY_TRAYICON_INITIAL_TOOLTIP

static final java.lang.String MESSAGEKEY_TRAYICON_INITIAL_TOOLTIP

See Also:

Constant Field Values

MESSAGEKEY_TRAYICON_MENU_EXIT

static final java.lang.String MESSAGEKEY_TRAYICON_MENU_EXIT

See Also:

Constant Field Values

MESSAGEKEY_TRAYICON_MENU_SORT

static final java.lang.String MESSAGEKEY_TRAYICON_MENU_SORT

See Also:

Constant Field Values

MESSAGEKEY_TRAYICON_MENUITEM_EXIT

static final java.lang.String MESSAGEKEY_TRAYICON_MENUITEM_EXIT

See Also:

Constant Field Values

MESSAGEKEY_TRAYICON_MENUITEM_SORT_BY_NAME

static final java.lang.String MESSAGEKEY_TRAYICON_MENUITEM_SORT_BY_NAME

See Also:

Constant Field Values

MESSAGEKEY_TRAYICON_MENUITEM_SORT_BY_AGE

static final java.lang.String MESSAGEKEY_TRAYICON_MENUITEM_SORT_BY_AGE

See Also:

Constant Field Values

MESSAGEKEY_TRAYICON_MENUITEM_UPDATE_STATUS_NOW

static final java.lang.String MESSAGEKEY_TRAYICON_MENUITEM_UPDATE_STATUS_NOW

See Also:

Constant Field Values

MESSAGEKEY_TRAYICON_MENUITEM_BUILD_SERVER_HOME_PAGE_SUFFIX

static final java.lang.String MESSAGEKEY_TRAYICON_MENUITEM_BUILD_SERVER_HOME_PAGE_SUFFIX

See Also:

Constant Field Values

MESSAGEKEY_TRAYICON_MENUITEM_ABOUT

static final java.lang.String MESSAGEKEY_TRAYICON_MENUITEM_ABOUT

See Also:

Constant Field Values

MESSAGEKEY_TRAYICON_MENUITEM_OPTIONS

static final java.lang.String MESSAGEKEY_TRAYICON_MENUITEM_OPTIONS

See Also:

Constant Field Values

MESSAGEKEY_ERROR_DIALOG_TITLE

static final java.lang.String MESSAGEKEY_ERROR_DIALOG_TITLE

See Also:

Constant Field Values

MESSAGEKEY_UNEXPECTED_ERROR_MESSAGE

static final java.lang.String MESSAGEKEY_UNEXPECTED_ERROR_MESSAGE

See Also:

Constant Field Values

MESSAGEKEY_ERROR_SYSTEMTRAY_NOT_SUPPORTED

static final java.lang.String MESSAGEKEY_ERROR_SYSTEMTRAY_NOT_SUPPORTED

See Also:

Constant Field Values

Method Detail

panic

void panic(java.lang.Throwable theUnexpectedProblem)

The method to call when an unrecoverable error occurs in the application. It displays an error message to the end user and then exit.

Parameters:

theUnexpectedProblem - the Throwable that was unexpected.

panic

void panic(java.lang.String theErrorMessage)

The method to call when an unrecoverable error occurs in the application and you want to display your own message (instead of a generic one).It displays your error message to the end user and then exit.

Parameters:

theErrorMessage - the error message to display to the end user.

getMessage

java.lang.String getMessage(java.lang.String theMessageKey)

Get a message identified by its key in the application resource bundle. The available messages key for the application all begins with prefix MESSAGEKEY_.

Parameters:

theMessageKey - the message key

Returns:

the message

getDialogsDefaultIcon

java.awt.Image getDialogsDefaultIcon()

Returns the default icon to be displayed by dialogs opened by monitors

Returns:

the default icon to be displayed by dialogs opened by monitors

updateBuildStatus

void updateBuildStatus(java.util.List<BuildReport> theBuildsStatus)

Update the build status (this method is called by build monitors to update the GUI when the build status has changed).

Parameters:

theBuildsStatus - a List that contains the each build report to use to update the global status.

reportMonitoringException

void reportMonitoringException(MonitoringException theMonitoringException)

Report a monitoring exception (this method is called by build monitors to notify that a monitoring exception occured)

Parameters:

theMonitoringException - the monitoring exception to display to the end user

reportConfigurationUpdatedToBeTakenIntoAccountImmediately

void reportConfigurationUpdatedToBeTakenIntoAccountImmediately()

Report an update of the monitor configuration to be taken into account immediately