org.apache.tools.ant.listener

Class BigProjectLogger

Implemented Interfaces:
BuildListener, EventListener, BuildListener, BuildLogger, SubBuildListener

public class BigProjectLogger
extends NoBannerLogger
implements SubBuildListener

This is a special logger that is designed to make it easier to work with big projects, those that use imports and subant to build complex systems.
Since:
Ant1.7.1

Field Summary

static String
FOOTER
Footer string for the log.
static String
HEADER
Header string for the log.

Fields inherited from class org.apache.tools.ant.NoBannerLogger

targetName

Fields inherited from class org.apache.tools.ant.DefaultLogger

LEFT_COLUMN_SIZE, emacsMode, err, lSep, msgOutputLevel, out

Method Summary

void
buildFinished(BuildEvent event)
void
buildStarted(BuildEvent event)
protected String
extractNameOrDefault(BuildEvent event)
Get the name of an event
protected String
extractTargetName(BuildEvent event)
Override point, extract the target name
protected String
getBuildFailedMessage()
This is an override point: the message that indicates whether a build failed.
protected String
getBuildSuccessfulMessage()
This is an override point: the message that indicates that a build succeeded.
protected String
getFooter()
Override point: return the footer string for the entry/exit message
protected String
getHeader()
Override point: return the header string for the entry/exit message
void
subBuildFinished(BuildEvent event)
void
subBuildStarted(BuildEvent event)

Methods inherited from class org.apache.tools.ant.NoBannerLogger

extractTargetName, messageLogged, targetFinished, targetStarted

Methods inherited from class org.apache.tools.ant.DefaultLogger

buildFinished, buildStarted, extractProjectName, formatTime, getBuildFailedMessage, getBuildSuccessfulMessage, getTimestamp, log, messageLogged, printMessage, setEmacsMode, setErrorPrintStream, setMessageOutputLevel, setOutputPrintStream, targetFinished, targetStarted, taskFinished, taskStarted

Field Details

FOOTER

public static final String FOOTER
Footer string for the log.

HEADER

public static final String HEADER
Header string for the log.

Method Details

buildFinished

public void buildFinished(BuildEvent event)
Specified by:
buildFinished in interface BuildListener
Overrides:
buildFinished in interface DefaultLogger
Parameters:
event -

buildStarted

public void buildStarted(BuildEvent event)
Specified by:
buildStarted in interface BuildListener
Overrides:
buildStarted in interface DefaultLogger
Parameters:
event -

extractNameOrDefault

protected String extractNameOrDefault(BuildEvent event)
Get the name of an event
Parameters:
event - the event name
Returns:
the name or a default string

extractTargetName

protected String extractTargetName(BuildEvent event)
Override point, extract the target name
Overrides:
extractTargetName in interface NoBannerLogger
Parameters:
event - the event to work on
Returns:
the target name -including the owning project name (if non-null)

getBuildFailedMessage

protected String getBuildFailedMessage()
This is an override point: the message that indicates whether a build failed. Subclasses can change/enhance the message.
Overrides:
getBuildFailedMessage in interface DefaultLogger
Returns:
The classic "BUILD FAILED" plus a timestamp

getBuildSuccessfulMessage

protected String getBuildSuccessfulMessage()
This is an override point: the message that indicates that a build succeeded. Subclasses can change/enhance the message.
Overrides:
getBuildSuccessfulMessage in interface DefaultLogger
Returns:
The classic "BUILD SUCCESSFUL" plus a timestamp

getFooter

protected String getFooter()
Override point: return the footer string for the entry/exit message
Returns:
the footer string

getHeader

protected String getHeader()
Override point: return the header string for the entry/exit message
Returns:
the header string

subBuildFinished

public void subBuildFinished(BuildEvent event)
Specified by:
subBuildFinished in interface SubBuildListener

subBuildStarted

public void subBuildStarted(BuildEvent event)
Specified by:
subBuildStarted in interface SubBuildListener
Parameters:
event - An event with any relevant extra information. Must not be null.