Package org.apache.tools.ant.listener
Class BigProjectLogger
java.lang.Object
org.apache.tools.ant.DefaultLogger
org.apache.tools.ant.NoBannerLogger
org.apache.tools.ant.listener.SimpleBigProjectLogger
org.apache.tools.ant.listener.BigProjectLogger
- All Implemented Interfaces:
java.util.EventListener
,BuildListener
,BuildLogger
,SubBuildListener
public class BigProjectLogger extends SimpleBigProjectLogger 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
Fields Modifier and Type Field Description static java.lang.String
FOOTER
Footer string for the log.static java.lang.String
HEADER
Header string for the log.Fields inherited from class org.apache.tools.ant.DefaultLogger
emacsMode, err, LEFT_COLUMN_SIZE, lSep, msgOutputLevel, out
-
Constructor Summary
Constructors Constructor Description BigProjectLogger()
-
Method Summary
Modifier and Type Method Description void
buildFinished(BuildEvent event)
Prints whether the build succeeded or failed, any errors the occurred during the build, and how long the build took.protected java.lang.String
extractNameOrDefault(BuildEvent event)
Get the name of an eventprotected java.lang.String
getBuildFailedMessage()
This is an override point: the message that indicates whether a build failed.protected java.lang.String
getBuildSuccessfulMessage()
This is an override point: the message that indicates that a build succeeded.protected java.lang.String
getFooter()
Override point: return the footer string for the entry/exit messageprotected java.lang.String
getHeader()
Override point: return the header string for the entry/exit messagevoid
messageLogged(BuildEvent event)
Logs a message for a target if it is of an appropriate priority, also logging the name of the target if this is the first message which needs to be logged for the target.void
subBuildFinished(BuildEvent event)
Signals that the last target has finished.void
subBuildStarted(BuildEvent event)
Signals that a subbuild has started.void
targetStarted(BuildEvent event)
Notes the name of the target so it can be logged if it generates any messages.void
taskStarted(BuildEvent event)
No-op implementation.Methods inherited from class org.apache.tools.ant.DefaultLogger
buildStarted, extractProjectName, formatTime, getTimestamp, log, printMessage, setEmacsMode, setErrorPrintStream, setMessageOutputLevel, setOutputPrintStream, taskFinished
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.tools.ant.BuildListener
buildStarted, targetFinished, taskFinished
-
Field Details
-
HEADER
public static final java.lang.String HEADERHeader string for the log. "======================================================================"- See Also:
- Constant Field Values
-
FOOTER
public static final java.lang.String FOOTERFooter string for the log. "======================================================================"- See Also:
- Constant Field Values
-
-
Constructor Details
-
BigProjectLogger
public BigProjectLogger()
-
-
Method Details
-
getBuildFailedMessage
protected java.lang.String getBuildFailedMessage()This is an override point: the message that indicates whether a build failed. Subclasses can change/enhance the message.- Overrides:
getBuildFailedMessage
in classDefaultLogger
- Returns:
- The classic "BUILD FAILED" plus a timestamp
-
getBuildSuccessfulMessage
protected java.lang.String getBuildSuccessfulMessage()This is an override point: the message that indicates that a build succeeded. Subclasses can change/enhance the message.- Overrides:
getBuildSuccessfulMessage
in classDefaultLogger
- Returns:
- The classic "BUILD SUCCESSFUL" plus a timestamp
-
targetStarted
Notes the name of the target so it can be logged if it generates any messages.- Specified by:
targetStarted
in interfaceBuildListener
- Overrides:
targetStarted
in classNoBannerLogger
- Parameters:
event
- BuildEvent- See Also:
BuildEvent.getTarget()
-
taskStarted
No-op implementation.- Specified by:
taskStarted
in interfaceBuildListener
- Overrides:
taskStarted
in classDefaultLogger
- Parameters:
event
- BuildEvent- See Also:
BuildEvent.getTask()
-
buildFinished
Prints whether the build succeeded or failed, any errors the occurred during the build, and how long the build took.- Specified by:
buildFinished
in interfaceBuildListener
- Overrides:
buildFinished
in classDefaultLogger
- Parameters:
event
- BuildEvent- See Also:
BuildEvent.getException()
-
messageLogged
Logs a message for a target if it is of an appropriate priority, also logging the name of the target if this is the first message which needs to be logged for the target.- Specified by:
messageLogged
in interfaceBuildListener
- Overrides:
messageLogged
in classNoBannerLogger
- Parameters:
event
- BuildEvent- See Also:
BuildEvent.getMessage()
,BuildEvent.getException()
,BuildEvent.getPriority()
-
subBuildStarted
Signals that a subbuild has started. This event is fired before any targets have started.- Specified by:
subBuildStarted
in interfaceSubBuildListener
- Parameters:
event
- An event with any relevant extra information. Must not benull
.
-
extractNameOrDefault
Get the name of an event- Parameters:
event
- the event name- Returns:
- the name or a default string
-
subBuildFinished
Signals that the last target has finished. This event will still be fired if an error occurred during the build.- Specified by:
subBuildFinished
in interfaceSubBuildListener
- Parameters:
event
- An event with any relevant extra information. Must not benull
.- See Also:
BuildEvent.getException()
-
getHeader
protected java.lang.String getHeader()Override point: return the header string for the entry/exit message- Returns:
- the header string
-
getFooter
protected java.lang.String getFooter()Override point: return the footer string for the entry/exit message- Returns:
- the footer string
-