net.sourceforge.cruisecontrol.listeners
Class CurrentBuildStatusPageListener

java.lang.Object
  net.sourceforge.cruisecontrol.listeners.CurrentBuildStatusPageListener

All Implemented Interfaces:

Listener, java.io.Serializable

public class CurrentBuildStatusPageListener

extends java.lang.Object

implements Listener

Updates replaceable text in a pattern file each time the Project status changes. Can show full project status history. The following items will be replaced with their values each time they occur in the source file:

• {Project} - Project Name.
• {State.Name} - Name of current project state.
• {State.Description} - Description of current project state.
• {State.Date} - Date/time the current state happened
• {State.Duration} - How long since this state was in effect. (Only useful in {History} line.)
• {History} - Historical states. Must be first on line. This line will be processed and output once for each state the project has previously been in. The {History} tag will be deleted from the line.

DateFormatFactory for the dateformat

Author:

John Lussmyer

See Also:

Serialized Form

Constructor Summary

CurrentBuildStatusPageListener()
Default constructor just used for initialization of local members.

Method Summary

static java.lang.String	formatDuration(long msecs) formats the given number of milliseconds as HH:MM:SS.sss
void	handleEvent(ProjectEvent event)
void	setFile(java.lang.String fileName)
void	setSourceFile(java.lang.String fileName)
void	validate() Called after the configuration is read to make sure that all the mandatory parameters were specified..

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CurrentBuildStatusPageListener

public CurrentBuildStatusPageListener()

Default constructor just used for initialization of local members.

Method Detail

handleEvent

public void handleEvent(ProjectEvent event)
                 throws CruiseControlException

Specified by:

handleEvent in interface Listener

Throws:

CruiseControlException

formatDuration

public static java.lang.String formatDuration(long msecs)

formats the given number of milliseconds as HH:MM:SS.sss

Parameters:

msecs - number of milliseconds

Returns:

String of the form HH:MM:SS.sss representing the given milliseconds

validate

public void validate()
              throws CruiseControlException

Description copied from interface: Listener

Called after the configuration is read to make sure that all the mandatory parameters were specified..

Specified by:

validate in interface Listener

Throws:

CruiseControlException - if there was a configuration error.

setFile

public void setFile(java.lang.String fileName)

setSourceFile

public void setSourceFile(java.lang.String fileName)