net.sourceforge.buildmonitor.monitors
Interface Monitor

All Superinterfaces:

java.lang.Runnable

All Known Implementing Classes:

BambooMonitor, CruiseControlRssMonitor

public interface Monitor
extends java.lang.Runnable

TODO: DOCUMENTS ME ! Monitor instance may be interrupted at any time by the build monitor main thread in order to immediately take into account a change in the configuration.

Author:

sbrunot

Method Summary

void	displayOptionsDialog() Display the options dialog on screen.
java.net.URI	getBuildURI(java.lang.String theIdOfTheBuild) Return an URI to the dedicated page of a build on the monitored build system
java.net.URI	getMainPageURI() Return an URI to the main page of the monitored build system
java.lang.String	getMonitoredBuildSystemName() Return the name of the monitored build system (to be used in tray icon popup menu entries)
java.lang.String	getSystemTrayIconTooltipHeader() Get the String to display as the first line of the Tooltip of the system tray icon.
void	stop() stop the monitor.

Methods inherited from interface java.lang.Runnable

run

Method Detail

stop

void stop()

stop the monitor.

getMonitoredBuildSystemName

java.lang.String getMonitoredBuildSystemName()

Return the name of the monitored build system (to be used in tray icon popup menu entries)

Returns:

the name of the monitored build system

getMainPageURI

java.net.URI getMainPageURI()

Return an URI to the main page of the monitored build system

getBuildURI

java.net.URI getBuildURI(java.lang.String theIdOfTheBuild)

Return an URI to the dedicated page of a build on the monitored build system

Parameters:

theIdOfTheBuild - the Id of the build (as in the BuildReport)

Returns:

an URI to the dedicated page of a build on the monitored build system

getSystemTrayIconTooltipHeader

java.lang.String getSystemTrayIconTooltipHeader()

Get the String to display as the first line of the Tooltip of the system tray icon.

Returns:

the String to display as the first line of the Tooltip of the system tray icon.

displayOptionsDialog

void displayOptionsDialog()

Display the options dialog on screen.