org.apache.tools.ant

Class XmlLogger

public class XmlLogger extends Object implements BuildLogger

Generates a file in the current directory with an XML description of what happened during a build. The default filename is "log.xml", but this can be overridden with the property XmlLogger.file. This implementation assumes in its sanity checking that only one thread runs a particular target/task at a time. This is enforced by the way that parallel builds and antcalls are done - and indeed all but the simplest of tasks could run into problems if executed in parallel.

See Also: addBuildListener

Constructor Summary
XmlLogger()
Constructs a new BuildListener that logs build events to an XML file.
Method Summary
voidbuildFinished(BuildEvent event)
Fired when the build finishes, this adds the time taken and any error stacktrace to the build element and writes the document to disk.
voidbuildStarted(BuildEvent event)
Fired when the build starts, this builds the top-level element for the document and remembers the time of the start of the build.
voidmessageLogged(BuildEvent event)
Fired when a message is logged, this adds a message element to the most appropriate parent element (task, target or build) and records the priority and text of the message.
voidsetEmacsMode(boolean emacsMode)
Ignore emacs mode, as it has no meaning in XML format
voidsetErrorPrintStream(PrintStream err)
Ignore error print stream.
voidsetMessageOutputLevel(int level)
Set the logging level when using this as a Logger
voidsetOutputPrintStream(PrintStream output)
Set the output stream to which logging output is sent when operating as a logger.
voidtargetFinished(BuildEvent event)
Fired when a target finishes building, this adds the time taken and any error stacktrace to the appropriate target element in the log.
voidtargetStarted(BuildEvent event)
Fired when a target starts building, this pushes a timed element for the target onto the stack of elements for the current thread, remembering the current time and the name of the target.
voidtaskFinished(BuildEvent event)
Fired when a task finishes building, this adds the time taken and any error stacktrace to the appropriate task element in the log.
voidtaskStarted(BuildEvent event)
Fired when a task starts building, this pushes a timed element for the task onto the stack of elements for the current thread, remembering the current time and the name of the task.

Constructor Detail

XmlLogger

public XmlLogger()
Constructs a new BuildListener that logs build events to an XML file.

Method Detail

buildFinished

public void buildFinished(BuildEvent event)
Fired when the build finishes, this adds the time taken and any error stacktrace to the build element and writes the document to disk.

Parameters: event An event with any relevant extra information. Will not be null.

buildStarted

public void buildStarted(BuildEvent event)
Fired when the build starts, this builds the top-level element for the document and remembers the time of the start of the build.

Parameters: event Ignored.

messageLogged

public void messageLogged(BuildEvent event)
Fired when a message is logged, this adds a message element to the most appropriate parent element (task, target or build) and records the priority and text of the message.

Parameters: event An event with any relevant extra information. Will not be null.

setEmacsMode

public void setEmacsMode(boolean emacsMode)
Ignore emacs mode, as it has no meaning in XML format

Parameters: emacsMode true if logger should produce emacs compatible output

setErrorPrintStream

public void setErrorPrintStream(PrintStream err)
Ignore error print stream. All output will be written to either the XML log file or the PrintStream provided to setOutputPrintStream

Parameters: err the stream we are going to ignore.

setMessageOutputLevel

public void setMessageOutputLevel(int level)
Set the logging level when using this as a Logger

Parameters: level the logging level - see {@link org.apache.tools.ant.Project#MSG_ERR Project} class for level definitions

setOutputPrintStream

public void setOutputPrintStream(PrintStream output)
Set the output stream to which logging output is sent when operating as a logger.

Parameters: output the output PrintStream.

targetFinished

public void targetFinished(BuildEvent event)
Fired when a target finishes building, this adds the time taken and any error stacktrace to the appropriate target element in the log.

Parameters: event An event with any relevant extra information. Will not be null.

targetStarted

public void targetStarted(BuildEvent event)
Fired when a target starts building, this pushes a timed element for the target onto the stack of elements for the current thread, remembering the current time and the name of the target.

Parameters: event An event with any relevant extra information. Will not be null.

taskFinished

public void taskFinished(BuildEvent event)
Fired when a task finishes building, this adds the time taken and any error stacktrace to the appropriate task element in the log.

Parameters: event An event with any relevant extra information. Will not be null.

taskStarted

public void taskStarted(BuildEvent event)
Fired when a task starts building, this pushes a timed element for the task onto the stack of elements for the current thread, remembering the current time and the name of the task.

Parameters: event An event with any relevant extra information. Will not be null.